-
-
Notifications
You must be signed in to change notification settings - Fork 30.8k
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.
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
Clarify documentation about PyVectorcall_Function #107140
Conversation
The documentation implies that PyVectorcall_NARGS, PyVectorcall_Function, and PyVectorcall_Call were available in Python 3.8. This is half-true - they were available under a different name. I think it's clearer to set the "version added" to 3.9
…stead of a private function that is now removed in Py3.13.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Only PyVectorcall_Function() versionadded is wrong, no?
Doc/c-api/call.rst
Outdated
@@ -140,7 +140,7 @@ Vectorcall Support API | |||
However, the function ``PyVectorcall_NARGS`` should be used to allow | |||
for future extensions. | |||
|
|||
.. versionadded:: 3.8 | |||
.. versionadded:: 3.9 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PyVectorcall_NARGS() is defined as a static inline function in Python 3.8.0: https://github.com/python/cpython/blob/v3.8.0/Include/cpython/abstract.h#L75
Doc/c-api/call.rst
Outdated
@@ -164,7 +164,7 @@ Vectorcall Support API | |||
It does not check the :c:macro:`Py_TPFLAGS_HAVE_VECTORCALL` flag | |||
and it does not fall back to ``tp_call``. | |||
|
|||
.. versionadded:: 3.8 | |||
.. versionadded:: 3.9 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In Python 3.8.0, PyVectorcall_Call() was already defined as a regular function: https://github.com/python/cpython/blob/v3.8.0/Include/cpython/abstract.h#L141
Thanks for the clarification @vstinner - I think I confused myself trying to look at diffs. |
Merged, thanks. |
GH-107173 is a backport of this pull request to the 3.12 branch. |
The documentation implies that PyVectorcall_Function() was available in Python 3.8. This is half-true - it was available under a different name. I think it's clearer to set the "version added" to 3.9. (cherry picked from commit 0a9b339) Co-authored-by: da-woods <dw-git@d-woods.co.uk>
GH-107174 is a backport of this pull request to the 3.11 branch. |
The documentation implies that PyVectorcall_Function() was available in Python 3.8. This is half-true - it was available under a different name. I think it's clearer to set the "version added" to 3.9. (cherry picked from commit 0a9b339) Co-authored-by: da-woods <dw-git@d-woods.co.uk>
Fix PyVectorcall_Function doc versionadded (GH-107140) The documentation implies that PyVectorcall_Function() was available in Python 3.8. This is half-true - it was available under a different name. I think it's clearer to set the "version added" to 3.9. (cherry picked from commit 0a9b339) Co-authored-by: da-woods <dw-git@d-woods.co.uk>
Fix PyVectorcall_Function doc versionadded (GH-107140) The documentation implies that PyVectorcall_Function() was available in Python 3.8. This is half-true - it was available under a different name. I think it's clearer to set the "version added" to 3.9. (cherry picked from commit 0a9b339) Co-authored-by: da-woods <dw-git@d-woods.co.uk>
* main: (73 commits) Thoroughly refactor the cases generator (python#107151) Docs: Add missing markup to Argument Clinic docs (python#106876) pythongh-107162: Document errcode.h usage in its comment (python#107177) pythongh-106320: Remove private _PyDict C API (python#107145) Fix PyVectorcall_Function doc versionadded (python#107140) Docs: Remove duplicate word in Argument Clinic howto heading (python#107169) pythongh-107017: Change Chapter Strings to Texts in the Introduction chapter. (python#107104) pythongh-106320: Remove private _PyObject C API (python#107159) Docs: fix typo in os.pwrite docstring (python#107087) pythongh-105291: Add link to migration guide for distutils (python#107130) pythongh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls (python#107062) pythongh-106320: Remove _PyBytes_Join() C API (python#107144) pythongh-106320: Remove private _PyObject C API (python#107147) pythongh-106320: Remove _PyTuple_MaybeUntrack() C API (python#107143) pythongh-106320: Remove _PyIsSelectable_fd() C API (python#107142) Remove superflous whitespaces in `layout.html`. (pythonGH-107067) pythongh-107122: Update what's news for dbm.*dbm.clear() method (pythongh-107135) pythongh-107122: Add clear method to dbm.ndbm module (pythongh-107126) pythongh-62519: Make pgettext search plurals when translation is not found (python#107118) pythongh-107122: Add clear method to dbm.gdbm.module (pythongh-107127) ...
The documentation implies that PyVectorcall_Function was available in Python 3.8.
This is half-true - it was available under a different name. I think it's clearer to set the "version added" to 3.9
📚 Documentation preview 📚: https://cpython-previews--107140.org.readthedocs.build/