Skip to content

Commit

Permalink
pythongh-127896: Add missing documentation of PySequence_In (python…
Browse files Browse the repository at this point in the history
…GH-127979)

Co-authored-by: Sergey B Kirpichev <[email protected]>
  • Loading branch information
koyuki7w and skirpichev authored Dec 16, 2024
1 parent 0d8e710 commit 52d552c
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 0 deletions.
9 changes: 9 additions & 0 deletions Doc/c-api/sequence.rst
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
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
4 changes: 4 additions & 0 deletions Doc/whatsnew/3.14.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1073,6 +1073,10 @@ Deprecated
:c:macro:`!isfinite` available from :file:`math.h`
since C99. (Contributed by Sergey B Kirpichev in :gh:`119613`.)

* The previously undocumented function :c:func:`PySequence_In` is :term:`soft deprecated`.
Use :c:func:`PySequence_Contains` instead.
(Contributed by Yuki Kobayashi in :gh:`127896`.)

.. Add C API deprecations above alphabetically, not here at the end.
.. include:: ../deprecations/c-api-pending-removal-in-3.15.rst
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
The previously undocumented function :c:func:`PySequence_In` is :term:`soft deprecated`.
Use :c:func:`PySequence_Contains` instead.

0 comments on commit 52d552c

Please sign in to comment.