Rooba
/
cpython
mirror of https://github.com/python/cpython.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

bpo-46076: Improve documentation for per-attribute docstrings with `__slots__` (GH-30109)

This commit is contained in:
Alex Waygood 2021-12-19 20:20:07 +00:00 committed by GitHub
parent 0b582a4a1b
commit aeb9ef4c72
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Doc/reference/datamodel.rst
View File

@ -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__*.