Intra-package References Documentation Incomplete
未关闭
还没有人认领这个 Issue。
docs
type-bug
- 主要语言
- Python
- 星标
- 77.2k
- 派生
- 36k
- 平均合并
- 1 天 9 小时
- 30 天内合并 PR
- 558
描述
| BPO | 35927 |
|---|---|
| Nosy | @brettcannon, @terryjreedy, @ncoghlan, @ericsnowcurrently |
| Files |
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee = None
closed_at = None
created_at = <Date 2019-02-07.04:38:30.393>
labels = ['3.8', 'type-bug', '3.7', 'docs']
title = 'Intra-package References Documentation Incomplete'
updated_at = <Date 2019-02-14.00:38:19.737>
user = 'https://bugs.python.org/ADataGman'
bugs.python.org fields:
activity = <Date 2019-02-14.00:38:19.737>
actor = 'ADataGman'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-02-07.04:38:30.393>
creator = 'ADataGman'
dependencies = []
files = ['48109']
hgrepos = []
issue_num = 35927
keywords = []
message_count = 7.0
messages = ['335002', '335104', '335105', '335126', '335303', '335385', '335486']
nosy_count = 6.0
nosy_names = ['brett.cannon', 'terry.reedy', 'ncoghlan', 'docs@python', 'eric.snow', 'ADataGman']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue35927'
versions = ['Python 3.7', 'Python 3.8']
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先阅读链接的 BPO issue 35927,并检查 sound.zip,即从文档中复制的代码示例。确定相关 Python 文档中缺失或不完整的包内引用。完成的标准是:文档完整覆盖示例所展示的引用,并且适当的文档检查通过。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 35/100