`type('', (), {})__weakref__.__doc__` is inaccurate
Open
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Documentation
The __weakref__ descriptor on an instance of user-defined classes is a weak reference (singular instance of weakref.ReferenceType, preferring the unique one with no callback passed to the constructor if it exists and the most recently created one if not in case of multiple, and None otherwise. However, it is documented as a "list of weak references to the object".
Linked PRs
- gh-151581
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read Objects/typeobject.c around line 4089 and inspect linked PR gh-151581. Compare the existing weakref descriptor wording with the behavior described in the issue; the documentation is done when it accurately describes the descriptor rather than calling it a list of weak references.
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
- 35/100