From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Thu, 28 Nov 2019 05:29:02 +0000 (-0800)
Subject: bpo-38524: clarify example a bit and improve formatting (GH-17406)
X-Git-Tag: v3.8.1rc1~34
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=c0db88f6abbace79644b2aca2290bf41b1a37174;p=thirdparty%2FPython%2Fcpython.git

bpo-38524: clarify example a bit and improve formatting (GH-17406)

(cherry picked from commit 02519f75d15b063914a11351da30178ca4ceb54b)

Co-authored-by: Tal Einat <taleinat+github@gmail.com>
---

diff --git a/Doc/reference/datamodel.rst b/Doc/reference/datamodel.rst
index ae24adeacb16..46d50ad600ff 100644
--- a/Doc/reference/datamodel.rst
+++ b/Doc/reference/datamodel.rst
@@ -1657,13 +1657,16 @@ class' :attr:`~object.__dict__`.
 
    .. note::
 
-      ``__set_name__`` is only called implicitly as part of the ``type`` constructor, so
-      it will need to be called explicitly with the appropriate parameters when a
-      descriptor is added to a class after initial creation::
+      :meth:`__set_name__` is only called implicitly as part of the
+      :class:`type` constructor, so it will need to be called explicitly with
+      the appropriate parameters when a descriptor is added to a class after
+      initial creation::
 
+         class A:
+            pass
          descr = custom_descriptor()
-         cls.attr = descr
-         descr.__set_name__(cls, 'attr')
+         A.attr = descr
+         descr.__set_name__(A, 'attr')
 
       See :ref:`class-object-creation` for more details.