python / python/cpython

weakref documentation does not fully describe proxies

Open
#86,708 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

BPO 42542

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-12-02.15:18:59.934>
labels = ['3.9', 'docs']
title = 'weakref documentation does not fully describe proxies'
updated_at = <Date 2020-12-02.15:18:59.934>
user = 'https://bugs.python.org/rgov'

bugs.python.org fields:

activity = <Date 2020-12-02.15:18:59.934>
actor = 'rgov'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-12-02.15:18:59.934>
creator = 'rgov'
dependencies = []
files = []
hgrepos = []
issue_num = 42542
keywords = []
message_count = 1.0
messages = ['382319']
nosy_count = 2.0
nosy_names = ['docs@python', 'rgov']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue42542'
versions = ['Python 3.9']

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

The issue concerns Python's weakref documentation and its coverage of proxies, but it names no file or specific missing details. Start by locating the weakref documentation and comparing its proxy coverage with the documented behavior; done means the documentation fully describes proxies and the relevant documentation checks pass.

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
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.