Skip to content

bpo-46076: Improve documentation for per-attribute docstrings with __slots__ #30109

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Dec 19, 2021
Merged

bpo-46076: Improve documentation for per-attribute docstrings with __slots__ #30109

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ad0e721
bpo-46076: Improve documentation for per-attribute docstrings with `_…
AlexWaygood Dec 14, 2021
5bfa153
Dictionaries are the only mapping supported
AlexWaygood Dec 15, 2021
616fcfb
Remove News entry
AlexWaygood Dec 16, 2021
3a00d4e
Merge branch 'slots-docs' of https://github.com/AlexWaygood/cpython i…
AlexWaygood Dec 16, 2021
c30b57f
Update datamodel.rst
AlexWaygood Dec 16, 2021
decef0f
Address review
AlexWaygood Dec 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions Doc/reference/datamodel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1944,9 +1944,12 @@ Notes on using *__slots__*
* Nonempty *__slots__* does not work for classes derived from "variable-length"
built-in types such as :class:`int`, :class:`bytes` and :class:`tuple`.

* 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.
* Any non-string :term:`iterable` may be assigned to *__slots__*.

* If a :class:`dictionary <dict>` is used to assign *__slots__*, the dictionary
keys will be used as the slot names. The values of the dictionary can be used
to provide per-attribute docstrings that will be recognised by
:func:`inspect.getdoc` and displayed in the output of :func:`help`.

* :attr:`~instance.__class__` assignment works only if both classes have the
same *__slots__*.
Expand Down