python / python/cpython

Mentions of pdb.set_trace() in library/functions and library/sys incorrectly states that set_trace expects no arguments

Open
#85,682 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

BPO 41510
Nosy @ronaldoussoren, @m-aciek, @ShubhamKJha
PRs
  • python/cpython#21793
  • 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-08-09.00:14:35.004>
    labels = ['3.7', '3.8', '3.9', '3.10', 'docs']
    title = 'Mentions of pdb.set_trace() in library/functions and library/sys incorrectly states that set_trace expects no arguments'
    updated_at = <Date 2020-08-14.16:35:58.204>
    user = 'https://github.com/m-aciek'
    

    bugs.python.org fields:

    activity = <Date 2020-08-14.16:35:58.204>
    actor = 'nanjekyejoannah'
    assignee = 'docs@python'
    closed = False
    closed_date = None
    closer = None
    components = ['Documentation']
    creation = <Date 2020-08-09.00:14:35.004>
    creator = 'Maciej Olko'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 41510
    keywords = ['patch']
    message_count = 2.0
    messages = ['375064', '375065']
    nosy_count = 4.0
    nosy_names = ['ronaldoussoren', 'docs@python', 'Maciej Olko', 'ShubhamKJha']
    pr_nums = ['21793']
    priority = 'normal'
    resolution = None
    stage = 'patch review'
    status = 'open'
    superseder = None
    type = None
    url = 'https://bugs.python.org/issue41510'
    versions = ['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 reading the pdb.set_trace() mentions in library/functions and library/sys, focusing on the wording about whether set_trace accepts arguments. Compare those statements with the documented behavior and update both references so they are accurate; the existing PR #21793 provides related context.

    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
    Clearly specified
    Newbie friendliness
    25/100

    Get new issues in your inbox

    A short digest of beginner-friendly GitHub issues.