Skip to content
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

Merged
merged 2 commits into from Jul 24, 2023
Merged

Conversation

da-woods
Copy link
Contributor

@da-woods da-woods commented Jul 23, 2023

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/

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
Copy link
Member

@vstinner vstinner left a 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?

@@ -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
Copy link
Member

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

@@ -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
Copy link
Member

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

@da-woods da-woods changed the title Clarify documentation about PyVectorcall_* Clarify documentation about PyVectorcall_Function Jul 24, 2023
@da-woods
Copy link
Contributor Author

Thanks for the clarification @vstinner - I think I confused myself trying to look at diffs.

@vstinner vstinner merged commit 0a9b339 into python:main Jul 24, 2023
20 checks passed
@vstinner
Copy link
Member

Merged, thanks.

@vstinner vstinner added needs backport to 3.11 only security fixes needs backport to 3.12 bug and security fixes labels Jul 24, 2023
@miss-islington
Copy link
Contributor

Thanks @da-woods for the PR, and @vstinner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@miss-islington
Copy link
Contributor

Thanks @da-woods for the PR, and @vstinner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@bedevere-bot
Copy link

GH-107173 is a backport of this pull request to the 3.12 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.12 bug and security fixes label Jul 24, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 24, 2023
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>
@bedevere-bot
Copy link

GH-107174 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Jul 24, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 24, 2023
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>
vstinner pushed a commit that referenced this pull request Jul 24, 2023
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>
vstinner pushed a commit that referenced this pull request Jul 24, 2023
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>
@da-woods da-woods deleted the patch-1 branch July 24, 2023 14:17
carljm added a commit to carljm/cpython that referenced this pull request Jul 24, 2023
* 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)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants