Skip to content

[3.11] gh-87961: Remove outdated notes from functions that aren't in the Limited API (GH-93581) #93604

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
ambv merged 1 commit into from
Jun 10, 2022
Merged

[3.11] gh-87961: Remove outdated notes from functions that aren't in the Limited API (GH-93581) #93604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
gh-87961: Remove outdated notes from functions that aren't in the Lim… 
…ited API (GH-93581)

* Remove outdated notes from functions that aren't in the Limited API

Nowadays everything that *is* in the Limited API has a note added
automatically.
These notes could mislead people to think that these functions
could never be added to the limited API. Remove them.

* Also remove forgotten note on tp_vectorcall_offset not being finalized
(cherry picked from commit 2c3fe5e)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
  • Loading branch information
@encukou @miss-islington
encukou authored and miss-islington committed Jun 8, 2022
commit d43fa9201783b497e4abaf4a40b69861d49a8bcc
18 changes: 0 additions & 18 deletions Doc/c-api/call.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,8 +144,6 @@ Vectorcall Support API
However, the function ``PyVectorcall_NARGS`` should be used to allow
for future extensions.

This function is not part of the :ref:`limited API <stable>`.

.. versionadded:: 3.8

.. c:function:: vectorcallfunc PyVectorcall_Function(PyObject *op)
Expand All @@ -158,8 +156,6 @@ Vectorcall Support API
This is mostly useful to check whether or not *op* supports vectorcall,
which can be done by checking ``PyVectorcall_Function(op) != NULL``.

This function is not part of the :ref:`limited API <stable>`.

.. versionadded:: 3.8

.. c:function:: PyObject* PyVectorcall_Call(PyObject *callable, PyObject *tuple, PyObject *dict)
Expand All @@ -172,8 +168,6 @@ Vectorcall Support API
It does not check the :const:`Py_TPFLAGS_HAVE_VECTORCALL` flag
and it does not fall back to ``tp_call``.

This function is not part of the :ref:`limited API <stable>`.

.. versionadded:: 3.8


Expand Down Expand Up @@ -256,8 +250,6 @@ please see individual documentation for details.
Return the result of the call on success, or raise an exception and return
*NULL* on failure.

This function is not part of the :ref:`limited API <stable>`.

.. versionadded:: 3.9


Expand Down Expand Up @@ -343,8 +335,6 @@ please see individual documentation for details.
Return the result of the call on success, or raise an exception and return
*NULL* on failure.

This function is not part of the :ref:`limited API <stable>`.

.. versionadded:: 3.9


Expand All @@ -357,8 +347,6 @@ please see individual documentation for details.
Return the result of the call on success, or raise an exception and return
*NULL* on failure.

This function is not part of the :ref:`limited API <stable>`.

.. versionadded:: 3.9


Expand All @@ -372,8 +360,6 @@ please see individual documentation for details.
Return the result of the call on success, or raise an exception and return
*NULL* on failure.

This function is not part of the :ref:`limited API <stable>`.

.. versionadded:: 3.9

.. c:function:: PyObject* PyObject_VectorcallDict(PyObject *callable, PyObject *const *args, size_t nargsf, PyObject *kwdict)
Expand All @@ -388,8 +374,6 @@ please see individual documentation for details.
already has a dictionary ready to use for the keyword arguments,
but not a tuple for the positional arguments.

This function is not part of the :ref:`limited API <stable>`.

.. versionadded:: 3.9

.. c:function:: PyObject* PyObject_VectorcallMethod(PyObject *name, PyObject *const *args, size_t nargsf, PyObject *kwnames)
Expand All @@ -410,8 +394,6 @@ please see individual documentation for details.
Return the result of the call on success, or raise an exception and return
*NULL* on failure.

This function is not part of the :ref:`limited API <stable>`.

.. versionadded:: 3.9


Expand Down
2 changes: 0 additions & 2 deletions Doc/c-api/structures.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,8 +321,6 @@ There are these calling conventions:
or possibly ``NULL`` if there are no keywords. The values of the keyword
arguments are stored in the *args* array, after the positional arguments.

This is not part of the :ref:`limited API <stable>`.

.. versionadded:: 3.7


Expand Down
6 changes: 0 additions & 6 deletions Doc/c-api/typeobj.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -727,12 +727,6 @@ and :c:type:`PyType_Type` effectively act as defaults.)
When a user sets :attr:`__call__` in Python code, only *tp_call* is updated,
likely making it inconsistent with the vectorcall function.

.. note::

The semantics of the ``tp_vectorcall_offset`` slot are provisional and
expected to be finalized in Python 3.9.
If you use vectorcall, plan for updating your code for Python 3.9.

.. versionchanged:: 3.8

Before version 3.8, this slot was named ``tp_print``.
Expand Down