python / python/cpython

Freeze support documentation is misleading.

Open
#80,334 8 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs easy type-bug
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 36153
Nosy @pitrou, @applio, @Windsooon, @samschott
Files
  • run_server_min.py: Python code to reproduce the issue.
  • 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-03-01.00:49:32.769>
    labels = ['3.7', 'docs']
    title = 'Freeze support documentation is misleading.'
    updated_at = <Date 2021-05-17.12:10:25.917>
    user = 'https://bugs.python.org/SridharIyer'
    

    bugs.python.org fields:

    activity = <Date 2021-05-17.12:10:25.917>
    actor = 'samschott'
    assignee = 'docs@python'
    closed = False
    closed_date = None
    closer = None
    components = ['Documentation']
    creation = <Date 2019-03-01.00:49:32.769>
    creator = 'Sridhar Iyer'
    dependencies = []
    files = ['48182']
    hgrepos = []
    issue_num = 36153
    keywords = []
    message_count = 4.0
    messages = ['336881', '336885', '336932', '393809']
    nosy_count = 6.0
    nosy_names = ['pitrou', 'docs@python', 'davin', 'Windson Yang', 'Sridhar Iyer', 'samschott']
    pr_nums = []
    priority = 'normal'
    resolution = None
    stage = None
    status = 'open'
    superseder = None
    type = None
    url = 'https://bugs.python.org/issue36153'
    versions = ['Python 2.7', 'Python 3.4', 'Python 3.5', 'Python 3.6', 'Python 3.7']
    

    Linked PRs
    • gh-134462
    • gh-134617
    • gh-134619
    • gh-134620
    • gh-134658

    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 issue description and the linked PRs gh-134462, gh-134617, gh-134619, gh-134620, and gh-134658, then inspect the freeze-support documentation they address. The issue names run_server_min.py as a reproduction file, but does not identify the documentation file or the precise misleading text. Done means the freeze-support documentation accurately reflects current behavior.

    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
    25/100

    Get new issues in your inbox

    A short digest of beginner-friendly GitHub issues.