Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing document of WeakValueDictionary.itervaluerefs #127388

Open
koyuki7w opened this issue Nov 29, 2024 · 3 comments
Open

Missing document of WeakValueDictionary.itervaluerefs #127388

koyuki7w opened this issue Nov 29, 2024 · 3 comments
Labels
docs Documentation in the Doc dir stdlib Python modules in the Lib dir

Comments

@koyuki7w
Copy link
Contributor

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 ecaab83. Perhaps the function itself should be removed.

@koyuki7w koyuki7w added the docs Documentation in the Doc dir label Nov 29, 2024
@sobolevn
Copy link
Member

sobolevn commented Nov 29, 2024

Good find! My first thought is that we've long passed the py3 migration point, it would not be safe to remove this function. But, since it is public, tested, and semi-documented (in the source code), maybe we should instead document it again? Since I am not an expert in weakref module, this is a question for others :)

@skirpichev
Copy link
Member

CC @freddrake

@skirpichev skirpichev added the stdlib Python modules in the Lib dir label Nov 30, 2024
@serhiy-storchaka
Copy link
Member

It looks that itervaluerefs() and iterkeyrefs() were planned to be renamed to valuerefs() and keyrefs(). But that change was incomplete and it was later partially reverted. We should investigate the history of these changes and find reasons for incompleting and reversion (it may be just mistake). cc @warsaw.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir stdlib Python modules in the Lib dir
Projects
Status: Todo
Development

No branches or pull requests

4 participants