python / python/cpython

Error in Python Datamodel Documentation

Open
#85,142 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

3.10 3.7 (EOL) 3.8 (EOL) 3.9 (EOL) docs type-feature
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 40970
Nosy @rhettinger, @chrisyeh96
PRs
  • python/cpython#20864
  • 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-06-13.23:37:57.780>
    labels = ['3.7', '3.8', '3.9', '3.10', 'type-feature', 'docs']
    title = 'Error in Python Datamodel Documentation'
    updated_at = <Date 2020-06-14.06:50:46.258>
    user = 'https://github.com/chrisyeh96'
    

    bugs.python.org fields:

    activity = <Date 2020-06-14.06:50:46.258>
    actor = 'chrisyeh96'
    assignee = 'docs@python'
    closed = False
    closed_date = None
    closer = None
    components = ['Documentation']
    creation = <Date 2020-06-13.23:37:57.780>
    creator = 'chrisyeh96'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 40970
    keywords = []
    message_count = 5.0
    messages = ['371473', '371480', '371481', '371482', '371493']
    nosy_count = 3.0
    nosy_names = ['rhettinger', 'docs@python', 'chrisyeh96']
    pr_nums = ['20864']
    priority = 'normal'
    resolution = None
    stage = None
    status = 'open'
    superseder = None
    type = 'enhancement'
    url = 'https://bugs.python.org/issue40970'
    versions = ['Python 3.5', 'Python 3.6', 'Python 3.7', 'Python 3.8', 'Python 3.9', 'Python 3.10']
    

    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 original BPO issue 40970 and the referenced PR #20864. The migrated issue names no file, documentation section, or test, so confirm what error remains and whether the PR already addresses it before determining what done means.

    Written by the indexing model from the issue text.

    Assessment

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

    Get new issues in your inbox

    A short digest of beginner-friendly GitHub issues.