mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-25 04:34:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

Issue #24808: Update the documentation of some PyTypeObject fields

Browse source 
Patch by Joseph Weston.
This commit is contained in:
Martin Panter 2015-08-25 05:06:39 +00:00
parent b372356d0a
commit 78d5033337
5 changed files with 19 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

10
Doc/c-api/typeobj.rst
View file

@ -94,7 +94,7 @@ type objects) *must* have the :attr:`ob_size` field.
This field is not inherited by subtypes.
.. c:member:: char* PyTypeObject.tp_name
.. c:member:: const char* PyTypeObject.tp_name
Pointer to a NUL-terminated string containing the name of the type. For types
that are accessible as module globals, the string should be the full module
@ -367,7 +367,7 @@ type objects) *must* have the :attr:`ob_size` field.
inherited individually.
.. c:member:: long PyTypeObject.tp_flags
.. c:member:: unsigned long PyTypeObject.tp_flags
This field is a bit mask of various flags. Some flags indicate variant
semantics for certain situations; others are used to indicate that certain
@ -467,7 +467,7 @@ type objects) *must* have the :attr:`ob_size` field.
.. versionadded:: 3.4
.. c:member:: char* PyTypeObject.tp_doc
.. c:member:: const char* PyTypeObject.tp_doc
An optional pointer to a NUL-terminated C string giving the docstring for this
type object. This is exposed as the :attr:`__doc__` attribute on the type and
@ -614,7 +614,7 @@ type objects) *must* have the :attr:`ob_size` field.
+----------------+------------+
.. c:member:: long PyTypeObject.tp_weaklistoffset
.. c:member:: Py_ssize_t PyTypeObject.tp_weaklistoffset
If the instances of this type are weakly referenceable, this field is greater
than zero and contains the offset in the instance structure of the weak
@ -781,7 +781,7 @@ type objects) *must* have the :attr:`ob_size` field.
.. XXX explain.
.. c:member:: long PyTypeObject.tp_dictoffset
.. c:member:: Py_ssize_t PyTypeObject.tp_dictoffset
If the instances of this type have a dictionary containing instance variables,
this field is non-zero and contains the offset in the instances of the type of