[docs] [issue35007] Minor change to weakref docs

Frank Millman report at bugs.python.org
Wed Oct 17 01:48:33 EDT 2018


New submission from Frank Millman <frank at chagford.com>:

weakref.WeakKeyDictionary.keyrefs() -

The documentation says 'Return an iterable of the weak references to the keys'.

I was not sure if this would expose me to the 'dictionary changed size while iterating' error, so I checked the source. The source shows that it returns a list, and the docstring says 'Return a list of weak references to the keys'.

I suggest that the documentation be changed to match the docstring.

The same applies to valuerefs().

----------
assignee: docs at python
components: Documentation
messages: 327863
nosy: docs at python, frankmillman
priority: normal
severity: normal
status: open
title: Minor change to weakref docs
type: behavior
versions: Python 3.7

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue35007>
_______________________________________


More information about the docs mailing list