diff options
| author | Martin Panter <vadmium> | 2015-08-25 05:06:39 (GMT) |
|---|---|---|
| committer | Martin Panter <vadmium> | 2015-08-25 05:06:39 (GMT) |
| commit | 78d5033337d7fd270f8c1c7153ccf7be84b52048 (patch) | |
| tree | 6b4e652c112a180a8dd9bcded20dda207020ff72 /Doc/c-api | |
| parent | b372356d0a7e553c3d76bafe5fdcfc5312b3fc15 (diff) | |
| download | cpython-78d5033337d7fd270f8c1c7153ccf7be84b52048.zip cpython-78d5033337d7fd270f8c1c7153ccf7be84b52048.tar.gz cpython-78d5033337d7fd270f8c1c7153ccf7be84b52048.tar.bz2 | |
Issue #24808: Update the documentation of some PyTypeObject fields
Patch by Joseph Weston.
Diffstat (limited to 'Doc/c-api')
| -rw-r--r-- | Doc/c-api/typeobj.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/Doc/c-api/typeobj.rst b/Doc/c-api/typeobj.rst index b43622a..5de8be0 100644 --- a/Doc/c-api/typeobj.rst +++ b/Doc/c-api/typeobj.rst @@ -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 |