Skip to content

GH-99293: Document that Py_TPFLAGS_VALID_VERSION_TAG shouldn't be used. #101736

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 9, 2023
Merged

GH-99293: Document that Py_TPFLAGS_VALID_VERSION_TAG shouldn't be used. #101736

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e06baa3
Document that Py_TPFLAGS_VALID_VERSION_TAG shouldn't be used.
markshannon Feb 9, 2023
17ba8bb
Update Doc/c-api/typeobj.rst
markshannon Feb 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions Doc/c-api/typeobj.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/C API/2023-02-09-10-38-20.gh-issue-99293.mFqfpp.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Document that the Py_TPFLAGS_VALID_VERSION_TAG is an internal feature,
should not be used, and will be removed.