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.
This commit is contained in:
Mark Shannon 2023-02-09 13:05:53 +00:00 committed by GitHub
parent 1c49e61b9b
commit ecfd2d37c5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 0 deletions

View file

@ -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

View file

@ -0,0 +1,2 @@
Document that the Py_TPFLAGS_VALID_VERSION_TAG is an internal feature,
should not be used, and will be removed.