iglob() has misleading documentation (does indeed store names internally)

Open
#66,363 20 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by reviewing the documentation for iglob() and the linked PR gh-117472. Confirm what the current text says about storing names internally, then update the wording so it accurately describes that behavior and verify the documentation changes.

Written by the indexing model from the issue text.

Description

docs type-feature
BPO 22167
Nosy @gvanrossum, @stevendaprano, @bitdancer, @serhiy-storchaka, @akulakov
PRs
  • python/cpython#25767
    		•

    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 2014-08-08.01:09:01.123>
labels = ['3.7', '3.8', '3.9', '3.10', 'type-feature', 'docs']
title = 'iglob() has misleading documentation (does indeed store names internally)'
updated_at = <Date 2021-06-21.19:36:46.362>
user = 'https://bugs.python.org/roysmith'

    bugs.python.org fields:

    activity = <Date 2021-06-21.19:36:46.362>
actor = 'andrei.avk'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2014-08-08.01:09:01.123>
creator = 'roysmith'
dependencies = []
files = []
hgrepos = []
issue_num = 22167
keywords = ['patch']
message_count = 18.0
messages = ['225048', '225050', '225051', '225069', '225070', '258010', '312257', '312275', '370489', '370491', '370492', '370499', '370505', '370544', '371613', '371615', '371687', '396283']
nosy_count = 9.0
nosy_names = ['gvanrossum', 'roysmith', 'steven.daprano', 'r.david.murray', 'docs@python', 'Gumnos', 'serhiy.storchaka', 'Roger Erens', 'andrei.avk']
pr_nums = ['25767']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue22167'
versions = ['Python 3.6', 'Python 3.7', 'Python 3.8', 'Python 3.9', 'Python 3.10']

    Linked PRs
    • gh-117472
    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.