python / python/cpython

Lib/cmd.py: Hide undocumented commands in help and completenames

Open
#81,211 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

3.8 (EOL) stdlib type-feature
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 37030
Nosy @remilapeyre, @tirkarthi, @aldwinaldwin
PRs
  • python/cpython#13536
  • 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-05-24.07:25:53.817>
    labels = ['3.8', 'type-feature', 'library']
    title = 'Lib/cmd.py: Hide undocumented commands in help and completenames'
    updated_at = <Date 2019-06-07.13:34:33.567>
    user = 'https://github.com/aldwinaldwin'
    

    bugs.python.org fields:

    activity = <Date 2019-06-07.13:34:33.567>
    actor = 'aldwinaldwin'
    assignee = 'none'
    closed = False
    closed_date = None
    closer = None
    components = ['Library (Lib)']
    creation = <Date 2019-05-24.07:25:53.817>
    creator = 'aldwinaldwin'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 37030
    keywords = ['patch']
    message_count = 6.0
    messages = ['343346', '343361', '343873', '344346', '344422', '344935']
    nosy_count = 3.0
    nosy_names = ['remi.lapeyre', 'xtreak', 'aldwinaldwin']
    pr_nums = ['13536']
    priority = 'normal'
    resolution = None
    stage = 'patch review'
    status = 'open'
    superseder = None
    type = 'enhancement'
    url = 'https://bugs.python.org/issue37030'
    versions = ['Python 3.8']
    

    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.

    Research direction

    Read Lib/cmd.py, focusing on the help and completenames entry points, and inspect python/cpython#13536 before starting because the issue records an existing pull request. Done means undocumented commands are hidden from both help output and completenames results; run the relevant library tests if available.

    Written by the indexing model from the issue text.

    Assessment

    Tech stack
    python
    Domain
    cli
    Issue type
    Feature
    Difficulty
    3/5
    Estimated time
    1-2 days
    Activity status
    Stale
    Clarity
    Clearly specified
    Newbie friendliness
    25/100

    Get new issues in your inbox

    A short digest of beginner-friendly GitHub issues.