python / python/cpython

Document the optional callback parameter of weakref.WeakMethod

Open
#91,376 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

BPO 47220
Nosy @rhettinger, @pitrou, @maggyero
PRs
  • python/cpython#25491
  • 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 2022-04-04.21:03:28.457>
    labels = ['type-feature', 'library', '3.9', '3.10', '3.11']
    title = 'Document the optional callback parameter of weakref.WeakMethod'
    updated_at = <Date 2022-04-05.05:34:31.580>
    user = 'https://github.com/maggyero'
    

    bugs.python.org fields:

    activity = <Date 2022-04-05.05:34:31.580>
    actor = 'rhettinger'
    assignee = 'none'
    closed = False
    closed_date = None
    closer = None
    components = ['Library (Lib)']
    creation = <Date 2022-04-04.21:03:28.457>
    creator = 'maggyero'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 47220
    keywords = []
    message_count = 2.0
    messages = ['416697', '416753']
    nosy_count = 3.0
    nosy_names = ['rhettinger', 'pitrou', 'maggyero']
    pr_nums = ['25491']
    priority = 'normal'
    resolution = None
    stage = None
    status = 'open'
    superseder = None
    type = 'enhancement'
    url = 'https://bugs.python.org/issue47220'
    versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']
    

    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 locating the documentation for weakref.WeakMethod in the CPython repository and review the existing description of its parameters. Document the optional callback parameter and verify that the resulting reference documentation accurately describes it; the issue body lists PR #25491, so check that work before proceeding.

    Written by the indexing model from the issue text.

    Assessment

    Tech stack
    python
    Domain
    documentation
    Issue type
    Documentation
    Difficulty
    1/5
    Estimated time
    Under an hour
    Activity status
    Stale
    Clarity
    Clearly specified
    Newbie friendliness
    25/100

    Get new issues in your inbox

    A short digest of beginner-friendly GitHub issues.