From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Sun, 19 Dec 2021 21:11:37 +0000 (-0800)
Subject: bpo-46076: Improve documentation for per-attribute docstrings with `__slots__` (GH... 
X-Git-Tag: v3.9.10~46
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=8bfb11a791679a33024c9857e082afed0d71e0b4;p=thirdparty%2FPython%2Fcpython.git

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

diff --git a/Doc/reference/datamodel.rst b/Doc/reference/datamodel.rst
index 1f0fc17ad360..967308b95ffc 100644
--- a/Doc/reference/datamodel.rst
+++ b/Doc/reference/datamodel.rst
@@ -1868,9 +1868,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__*.