python / python/cpython

Missing document of `WeakValueDictionary.itervaluerefs`

Open
#127,388 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs stdlib
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

Documentation

WeakValueDictionary.itervaluerefs in https://github.com/python/cpython/blob/main/Lib/weakref.py#L186 has no document.

The document once existed, but removed in commit https://github.com/python/cpython/commit/ecaab837b6ef36edf1840afdba1fbab747c049d7. Perhaps the function itself should be removed.

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

Inspect WeakValueDictionary.itervaluerefs in Lib/weakref.py around line 186 and review commit ecaab837b6ef36edf1840afdba1fbab747c049d7. Determine whether the missing documentation should be restored or the function removed. Done means the chosen direction is reflected consistently in the CPython source and documentation.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.