Skip to content

gh-127896: Add missing document of PySequence_In #127979

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 7 commits into from
Dec 16, 2024
Merged

gh-127896: Add missing document of PySequence_In #127979

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
312bb44
gh-127896: Add missing document of `PySequence_In`
Dec 10, 2024
2751a76
Update Doc/c-api/sequence.rst
Dec 16, 2024
dfe64b0
Add news and whatsnew entry
Dec 16, 2024
59f43d3
Fixup
Dec 16, 2024
4b752e9
Update Doc/whatsnew/3.14.rst
Dec 16, 2024
b40afc1
Update 2024-12-16-07-12-15.gh-issue-127896.HmI9pk.rst
Dec 16, 2024
d45aace
Update 3.14.rst
Dec 16, 2024
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
9 changes: 9 additions & 0 deletions Doc/c-api/sequence.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,15 @@ Sequence Protocol
equivalent to the Python expression ``value in o``.


.. c:function:: int PySequence_In(PyObject *o, PyObject *value)

Alias for :c:func:`PySequence_Contains`.

.. deprecated:: 3.14
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have this fancy thing these days:

Suggested change
.. deprecated:: 3.14
.. deprecated:: next

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do, and it makes backporting easier, but backporting a deprecation doesn't make much sense :)

The function is :term:`soft deprecated` and should no longer be used to
write new code.


.. c:function:: Py_ssize_t PySequence_Index(PyObject *o, PyObject *value)

Return the first index *i* for which ``o[i] == value``. On error, return
Expand Down
Loading