pkgutil.walk_packages "prefix" option docs are misleading

Open
#77,391 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
38/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Read the pkgutil.walk_packages documentation and compare its description of the prefix option with the behavior demonstrated by the attached test.py. Update the documentation so it accurately describes that behavior, then verify that the revised wording matches the test program's results.

Written by the indexing model from the issue text.

Description

3.7 (EOL) docs type-bug
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']

    Dominant language
    Python
    Stars
    77.2k
    Forks
    36k
    Avg merge
    1d 9h
    Merged PRs (30d)
    558

    Contributor guide

    Open the contributing guide

    First steps

    1. Read the whole issue, then the project's contributing guide.
    2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
    3. Fork the repository and make your change on a branch.
    4. Open a pull request that references the issue number.

    More from python/cpython

    All issues in python/cpython

    Similar issues

    More Python issues

    Get new issues in your inbox

    A short digest of beginner-friendly GitHub issues.