summaryrefslogtreecommitdiff
path: root/Doc/extending
diff options
context:
space:
mode:
authorSerhiy Storchaka <storchaka@gmail.com>2016-10-07 23:24:35 +0300
committerSerhiy Storchaka <storchaka@gmail.com>2016-10-07 23:24:35 +0300
commitde0574bdabc1183706406b421dea2e3e3c165eb3 (patch)
tree64b0977a9369569ad93d106940262a629938e934 /Doc/extending
parent8793b215253bf69cc699fab77b12d7f1313360d8 (diff)
downloadcpython-git-de0574bdabc1183706406b421dea2e3e3c165eb3.tar.gz
Issue #18287: PyType_Ready() now checks that tp_name is not NULL.
Original patch by Niklas Koep.
Diffstat (limited to 'Doc/extending')
-rw-r--r--Doc/extending/newtypes.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/Doc/extending/newtypes.rst b/Doc/extending/newtypes.rst
index a69f114fe4..4a6e26cf2a 100644
--- a/Doc/extending/newtypes.rst
+++ b/Doc/extending/newtypes.rst
@@ -129,7 +129,9 @@ our objects and in some error messages, for example::
Note that the name is a dotted name that includes both the module name and the
name of the type within the module. The module in this case is :mod:`noddy` and
-the type is :class:`Noddy`, so we set the type name to :class:`noddy.Noddy`. ::
+the type is :class:`Noddy`, so we set the type name to :class:`noddy.Noddy`.
+One side effect of using an undotted name is that the pydoc documentation tool
+will not list the new type in the module documentation. ::
sizeof(noddy_NoddyObject), /* tp_basicsize */