python / python/cpython

adding PEP references to documentation

Open
#85,953 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 41787
Nosy @cameron-simpson
PRs
  • python/cpython#22269
  • 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 2020-09-14.22:49:01.149>
    labels = ['docs']
    title = 'adding PEP references to documentation'
    updated_at = <Date 2020-09-16.03:26:47.313>
    user = 'https://github.com/cameron-simpson'
    

    bugs.python.org fields:

    activity = <Date 2020-09-16.03:26:47.313>
    actor = 'cameron'
    assignee = 'docs@python'
    closed = False
    closed_date = None
    closer = None
    components = ['Documentation']
    creation = <Date 2020-09-14.22:49:01.149>
    creator = 'cameron'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 41787
    keywords = ['patch']
    message_count = 3.0
    messages = ['376914', '376967', '376968']
    nosy_count = 2.0
    nosy_names = ['cameron', 'docs@python']
    pr_nums = ['22269']
    priority = 'normal'
    resolution = None
    stage = 'patch review'
    status = 'open'
    superseder = None
    type = None
    url = 'https://bugs.python.org/issue41787'
    versions = []
    

    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

    Start by reviewing the migrated issue details and PR #22269, since no documentation files or tests are named. Determine which documentation pages and PEP references the existing work covers, then verify that the intended references are present and the documentation build passes.

    Written by the indexing model from the issue text.

    Assessment

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

    Get new issues in your inbox

    A short digest of beginner-friendly GitHub issues.