This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author AlexWaygood
Recipients AlexWaygood, docs@python, rhettinger
Date 2021-12-14.22:25:11
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1639520711.47.0.591169978723.issue46076@roundup.psfhosted.org>
In-reply-to
Content
The ability to add docstrings for individual attributes, by using a dictionary for __slots__ was added in Issue36326. This is a fantastic feature, and deserves better documentation. It appears to currently only be documented in the "What's New" entry for Python 3.8: https://docs.python.org/3/whatsnew/3.8.html#inspect.

Moreover, the data model documentation currently states the following regarding using a mapping to specify __slots__:

"""
Any non-string iterable may be assigned to __slots__. Mappings may also be used; however, in the future, special meaning may be assigned to the values corresponding to each key.
"""

This is arguably now incorrect. A special meaning has been assigned to the values corresponding to each key: the values can be used for per-attribute docstrings.
History
Date User Action Args
2021-12-14 22:25:11AlexWaygoodsetrecipients: + AlexWaygood, rhettinger, docs@python
2021-12-14 22:25:11AlexWaygoodsetmessageid: <1639520711.47.0.591169978723.issue46076@roundup.psfhosted.org>
2021-12-14 22:25:11AlexWaygoodlinkissue46076 messages
2021-12-14 22:25:11AlexWaygoodcreate