mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-12 07:02:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

docs: correct references to __isub__ etc (GH-28297)

Browse source
This commit is contained in:
David Hewitt 2021-09-16 09:33:41 +01:00 • committed by GitHub
parent 9fd87a5fe5
commit 800bd01b6d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 132 additions and 132 deletions
Download patch file Download diff file Expand all files Collapse all files

142
Doc/c-api/typeobj.rst
View file

@ -189,138 +189,138 @@ sub-slots
.. table:: .. table::
:widths: 26,17,12 :widths: 26,17,12
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| Slot | :ref:`Type <slot-typedefs-table>` | special | | Slot | :ref:`Type <slot-typedefs-table>` | special |
| | | methods | | | | methods |
+=========================================================+===================================+==============+ +=========================================================+===================================+===============+
| :c:member:`~PyAsyncMethods.am_await` | :c:type:`unaryfunc` | __await__ | | :c:member:`~PyAsyncMethods.am_await` | :c:type:`unaryfunc` | __await__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyAsyncMethods.am_aiter` | :c:type:`unaryfunc` | __aiter__ | | :c:member:`~PyAsyncMethods.am_aiter` | :c:type:`unaryfunc` | __aiter__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyAsyncMethods.am_anext` | :c:type:`unaryfunc` | __anext__ | | :c:member:`~PyAsyncMethods.am_anext` | :c:type:`unaryfunc` | __anext__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyAsyncMethods.am_send` | :c:type:`sendfunc` | | | :c:member:`~PyAsyncMethods.am_send` | :c:type:`sendfunc` | |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| | | |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_add` | :c:type:`binaryfunc` | __add__ | | :c:member:`~PyNumberMethods.nb_add` | :c:type:`binaryfunc` | __add__ |
| | | __radd__ | | | | __radd__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_add` | :c:type:`binaryfunc` | __iadd__ | | :c:member:`~PyNumberMethods.nb_inplace_add` | :c:type:`binaryfunc` | __iadd__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_subtract` | :c:type:`binaryfunc` | __sub__ | | :c:member:`~PyNumberMethods.nb_subtract` | :c:type:`binaryfunc` | __sub__ |
| | | __rsub__ | | | | __rsub__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_subtract` | :c:type:`binaryfunc` | __sub__ | | :c:member:`~PyNumberMethods.nb_inplace_subtract` | :c:type:`binaryfunc` | __isub__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_multiply` | :c:type:`binaryfunc` | __mul__ | | :c:member:`~PyNumberMethods.nb_multiply` | :c:type:`binaryfunc` | __mul__ |
| | | __rmul__ | | | | __rmul__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_multiply` | :c:type:`binaryfunc` | __mul__ | | :c:member:`~PyNumberMethods.nb_inplace_multiply` | :c:type:`binaryfunc` | __imul__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_remainder` | :c:type:`binaryfunc` | __mod__ | | :c:member:`~PyNumberMethods.nb_remainder` | :c:type:`binaryfunc` | __mod__ |
| | | __rmod__ | | | | __rmod__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_remainder` | :c:type:`binaryfunc` | __mod__ | | :c:member:`~PyNumberMethods.nb_inplace_remainder` | :c:type:`binaryfunc` | __imod__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_divmod` | :c:type:`binaryfunc` | __divmod__ | | :c:member:`~PyNumberMethods.nb_divmod` | :c:type:`binaryfunc` | __divmod__ |
| | | __rdivmod__ | | | | __rdivmod__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_power` | :c:type:`ternaryfunc` | __pow__ | | :c:member:`~PyNumberMethods.nb_power` | :c:type:`ternaryfunc` | __pow__ |
| | | __rpow__ | | | | __rpow__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_power` | :c:type:`ternaryfunc` | __pow__ | | :c:member:`~PyNumberMethods.nb_inplace_power` | :c:type:`ternaryfunc` | __ipow__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_negative` | :c:type:`unaryfunc` | __neg__ | | :c:member:`~PyNumberMethods.nb_negative` | :c:type:`unaryfunc` | __neg__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_positive` | :c:type:`unaryfunc` | __pos__ | | :c:member:`~PyNumberMethods.nb_positive` | :c:type:`unaryfunc` | __pos__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_absolute` | :c:type:`unaryfunc` | __abs__ | | :c:member:`~PyNumberMethods.nb_absolute` | :c:type:`unaryfunc` | __abs__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_bool` | :c:type:`inquiry` | __bool__ | | :c:member:`~PyNumberMethods.nb_bool` | :c:type:`inquiry` | __bool__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_invert` | :c:type:`unaryfunc` | __invert__ | | :c:member:`~PyNumberMethods.nb_invert` | :c:type:`unaryfunc` | __invert__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_lshift` | :c:type:`binaryfunc` | __lshift__ | | :c:member:`~PyNumberMethods.nb_lshift` | :c:type:`binaryfunc` | __lshift__ |
| | | __rlshift__ | | | | __rlshift__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_lshift` | :c:type:`binaryfunc` | __lshift__ | | :c:member:`~PyNumberMethods.nb_inplace_lshift` | :c:type:`binaryfunc` | __ilshift__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_rshift` | :c:type:`binaryfunc` | __rshift__ | | :c:member:`~PyNumberMethods.nb_rshift` | :c:type:`binaryfunc` | __rshift__ |
| | | __rrshift__ | | | | __rrshift__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_rshift` | :c:type:`binaryfunc` | __rshift__ | | :c:member:`~PyNumberMethods.nb_inplace_rshift` | :c:type:`binaryfunc` | __irshift__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_and` | :c:type:`binaryfunc` | __and__ | | :c:member:`~PyNumberMethods.nb_and` | :c:type:`binaryfunc` | __and__ |
| | | __rand__ | | | | __rand__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_and` | :c:type:`binaryfunc` | __and__ | | :c:member:`~PyNumberMethods.nb_inplace_and` | :c:type:`binaryfunc` | __iand__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_xor` | :c:type:`binaryfunc` | __xor__ | | :c:member:`~PyNumberMethods.nb_xor` | :c:type:`binaryfunc` | __xor__ |
| | | __rxor__ | | | | __rxor__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_xor` | :c:type:`binaryfunc` | __xor__ | | :c:member:`~PyNumberMethods.nb_inplace_xor` | :c:type:`binaryfunc` | __ixor__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_or` | :c:type:`binaryfunc` | __or__ | | :c:member:`~PyNumberMethods.nb_or` | :c:type:`binaryfunc` | __or__ |
| | | __ror__ | | | | __ror__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_or` | :c:type:`binaryfunc` | __or__ | | :c:member:`~PyNumberMethods.nb_inplace_or` | :c:type:`binaryfunc` | __ior__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_int` | :c:type:`unaryfunc` | __int__ | | :c:member:`~PyNumberMethods.nb_int` | :c:type:`unaryfunc` | __int__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_reserved` | void * | | | :c:member:`~PyNumberMethods.nb_reserved` | void * | |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_float` | :c:type:`unaryfunc` | __float__ | | :c:member:`~PyNumberMethods.nb_float` | :c:type:`unaryfunc` | __float__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_floor_divide` | :c:type:`binaryfunc` | __floordiv__ | | :c:member:`~PyNumberMethods.nb_floor_divide` | :c:type:`binaryfunc` | __floordiv__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_floor_divide` | :c:type:`binaryfunc` | __floordiv__ | | :c:member:`~PyNumberMethods.nb_inplace_floor_divide` | :c:type:`binaryfunc` | __ifloordiv__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_true_divide` | :c:type:`binaryfunc` | __truediv__ | | :c:member:`~PyNumberMethods.nb_true_divide` | :c:type:`binaryfunc` | __truediv__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_true_divide` | :c:type:`binaryfunc` | __truediv__ | | :c:member:`~PyNumberMethods.nb_inplace_true_divide` | :c:type:`binaryfunc` | __itruediv__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_index` | :c:type:`unaryfunc` | __index__ | | :c:member:`~PyNumberMethods.nb_index` | :c:type:`unaryfunc` | __index__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_matrix_multiply` | :c:type:`binaryfunc` | __matmul__ | | :c:member:`~PyNumberMethods.nb_matrix_multiply` | :c:type:`binaryfunc` | __matmul__ |
| | | __rmatmul__ | | | | __rmatmul__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyNumberMethods.nb_inplace_matrix_multiply` | :c:type:`binaryfunc` | __matmul__ | | :c:member:`~PyNumberMethods.nb_inplace_matrix_multiply` | :c:type:`binaryfunc` | __imatmul__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| | | |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyMappingMethods.mp_length` | :c:type:`lenfunc` | __len__ | | :c:member:`~PyMappingMethods.mp_length` | :c:type:`lenfunc` | __len__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyMappingMethods.mp_subscript` | :c:type:`binaryfunc` | __getitem__ | | :c:member:`~PyMappingMethods.mp_subscript` | :c:type:`binaryfunc` | __getitem__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyMappingMethods.mp_ass_subscript` | :c:type:`objobjargproc` | __setitem__, | | :c:member:`~PyMappingMethods.mp_ass_subscript` | :c:type:`objobjargproc` | __setitem__, |
| | | __delitem__ | | | | __delitem__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| | | |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PySequenceMethods.sq_length` | :c:type:`lenfunc` | __len__ | | :c:member:`~PySequenceMethods.sq_length` | :c:type:`lenfunc` | __len__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PySequenceMethods.sq_concat` | :c:type:`binaryfunc` | __add__ | | :c:member:`~PySequenceMethods.sq_concat` | :c:type:`binaryfunc` | __add__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PySequenceMethods.sq_repeat` | :c:type:`ssizeargfunc` | __mul__ | | :c:member:`~PySequenceMethods.sq_repeat` | :c:type:`ssizeargfunc` | __mul__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PySequenceMethods.sq_item` | :c:type:`ssizeargfunc` | __getitem__ | | :c:member:`~PySequenceMethods.sq_item` | :c:type:`ssizeargfunc` | __getitem__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PySequenceMethods.sq_ass_item` | :c:type:`ssizeobjargproc` | __setitem__ | | :c:member:`~PySequenceMethods.sq_ass_item` | :c:type:`ssizeobjargproc` | __setitem__ |
| | | __delitem__ | | | | __delitem__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PySequenceMethods.sq_contains` | :c:type:`objobjproc` | __contains__ | | :c:member:`~PySequenceMethods.sq_contains` | :c:type:`objobjproc` | __contains__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PySequenceMethods.sq_inplace_concat` | :c:type:`binaryfunc` | __iadd__ | | :c:member:`~PySequenceMethods.sq_inplace_concat` | :c:type:`binaryfunc` | __iadd__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PySequenceMethods.sq_inplace_repeat` | :c:type:`ssizeargfunc` | __imul__ | | :c:member:`~PySequenceMethods.sq_inplace_repeat` | :c:type:`ssizeargfunc` | __imul__ |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| | | |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyBufferProcs.bf_getbuffer` | :c:func:`getbufferproc` | | | :c:member:`~PyBufferProcs.bf_getbuffer` | :c:func:`getbufferproc` | |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyBufferProcs.bf_releasebuffer` | :c:func:`releasebufferproc` | | | :c:member:`~PyBufferProcs.bf_releasebuffer` | :c:func:`releasebufferproc` | |
+---------------------------------------------------------+-----------------------------------+--------------+ +---------------------------------------------------------+-----------------------------------+---------------+
.. _slot-typedefs-table: .. _slot-typedefs-table: