python / python/cpython

pkgutil.walk_packages "prefix" option docs are misleading

未关闭
#77,391 4 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

3.7 (EOL) docs type-bug
主要语言
Python
星标
77.2k
派生
36k
平均合并
1 天 9 小时
30 天内合并 PR
558

描述

BPO 33210
Nosy @ncoghlan, @ericsnowcurrently, @cykerway
Files
  • test.py: Test program showing difference of behavior.
  • 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 2018-04-03.02:25:38.194>
    labels = ['type-bug', '3.7', 'docs']
    title = 'pkgutil.walk_packages "prefix" option docs are misleading'
    updated_at = <Date 2018-04-06.14:30:40.552>
    user = 'https://github.com/cykerway'
    

    bugs.python.org fields:

    activity = <Date 2018-04-06.14:30:40.552>
    actor = 'ncoghlan'
    assignee = 'docs@python'
    closed = False
    closed_date = None
    closer = None
    components = ['Documentation']
    creation = <Date 2018-04-03.02:25:38.194>
    creator = 'cykerway'
    dependencies = []
    files = ['47519']
    hgrepos = []
    issue_num = 33210
    keywords = []
    message_count = 4.0
    messages = ['314850', '314960', '315017', '315018']
    nosy_count = 4.0
    nosy_names = ['ncoghlan', 'docs@python', 'eric.snow', 'cykerway']
    pr_nums = []
    priority = 'normal'
    resolution = None
    stage = None
    status = 'open'
    superseder = None
    type = 'behavior'
    url = 'https://bugs.python.org/issue33210'
    versions = ['Python 3.6', 'Python 3.7']
    

    贡献指南

    打开贡献指南

    从这里开始

    1. 先读完整个 Issue,再读项目的贡献指南。
    2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
    3. Fork 仓库,在一个分支上完成修改。
    4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

    调研方向

    阅读 pkgutil.walk_packages 的文档,并将其中对 prefix 选项的描述与所附 test.py 展示的行为进行比较。更新文档,使其准确描述该行为,然后验证修改后的措辞与测试程序的结果一致。

    由索引模型根据 Issue 内容生成。

    评估

    技术栈
    python
    领域
    documentation
    Issue 类型
    文档
    难度
    2/5
    预计耗时
    1-3 小时
    活跃度
    停滞
    描述清晰度
    基本清楚
    新手友好度
    38/100

    把新 issue 发到你的邮箱

    精选适合新手参与的 GitHub issue 摘要。