summaryrefslogtreecommitdiffstats
path: root/Doc/c-api
diff options
context:
space:
mode:
authorMark Shannon <mark@hotpy.org>2023-02-09 13:05:53 (GMT)
committerGitHub <noreply@github.com>2023-02-09 13:05:53 (GMT)
commitecfd2d37c529c1952dc11fabe1758156924de67a (patch)
tree2d7dfeec9d328b6aa0f09bbfdee6a03933196ddf /Doc/c-api
parent1c49e61b9b18d550b9c5cff69a1dd3bb218e544a (diff)
downloadcpython-ecfd2d37c529c1952dc11fabe1758156924de67a.zip
cpython-ecfd2d37c529c1952dc11fabe1758156924de67a.tar.gz
cpython-ecfd2d37c529c1952dc11fabe1758156924de67a.tar.bz2
GH-99293: Document that `Py_TPFLAGS_VALID_VERSION_TAG` shouldn't be used. (#GH-101736)
Document that Py_TPFLAGS_VALID_VERSION_TAG shouldn't be used.
Diffstat (limited to 'Doc/c-api')
-rw-r--r--Doc/c-api/typeobj.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/Doc/c-api/typeobj.rst b/Doc/c-api/typeobj.rst
index 644830b..fd8f49c 100644
--- a/Doc/c-api/typeobj.rst
+++ b/Doc/c-api/typeobj.rst
@@ -1313,6 +1313,16 @@ and :c:type:`PyType_Type` effectively act as defaults.)
.. versionadded:: 3.10
+ .. data:: Py_TPFLAGS_VALID_VERSION_TAG
+
+ Internal. Do not set or unset this flag.
+ To indicate that a class has changed call :c:func:`PyType_Modified`
+
+ .. warning::
+ This flag is present in header files, but is an internal feature and should
+ not be used. It will be removed in a future version of CPython
+
+
.. c:member:: const char* PyTypeObject.tp_doc
An optional pointer to a NUL-terminated C string giving the docstring for this