Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2026-06-18 07:32:45 +00:00
Code Issues Projects Releases Packages Wiki Activity

[3.14] gh-141623: Clarify operator function descriptions (GH-141846)

Browse source 
(cherry picked from commit bd5fa31c5f)

Co-authored-by: Doron Behar <doron.behar@gmail.com>
This commit is contained in:
Miss Islington (bot) 2026-06-08 14:20:46 +02:00 • committed by GitHub
parent 6bd2e08a5d
commit 3c6c8bfde7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 18 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

31
Doc/library/operator.rst
View file

@ -112,7 +112,7 @@ The mathematical and bitwise operations are the most numerous:
.. function:: and_(a, b)
__and__(a, b)
Return the bitwise and of *a* and *b*.
Return ``a & b``.
.. function:: floordiv(a, b)
@ -136,13 +136,13 @@ The mathematical and bitwise operations are the most numerous:
__inv__(obj)
__invert__(obj)
Return the bitwise inverse of the number *obj*. This is equivalent to ``~obj``.
Return ``~obj``.
.. function:: lshift(a, b)
__lshift__(a, b)
Return *a* shifted left by *b*.
Return ``a << b``.
.. function:: mod(a, b)
@ -154,7 +154,7 @@ The mathematical and bitwise operations are the most numerous:
.. function:: mul(a, b)
__mul__(a, b)
Return ``a * b``, for *a* and *b* numbers.
Return ``a * b``.
.. function:: matmul(a, b)
@ -174,25 +174,25 @@ The mathematical and bitwise operations are the most numerous:
.. function:: or_(a, b)
__or__(a, b)
Return the bitwise or of *a* and *b*.
Return ``a | b``.
.. function:: pos(obj)
__pos__(obj)
Return *obj* positive (``+obj``).
Return ``+obj``.
.. function:: pow(a, b)
__pow__(a, b)
Return ``a ** b``, for *a* and *b* numbers.
Return ``a ** b``.
.. function:: rshift(a, b)
__rshift__(a, b)
Return *a* shifted right by *b*.
Return ``a >> b``.
.. function:: sub(a, b)
@ -211,7 +211,7 @@ The mathematical and bitwise operations are the most numerous:
.. function:: xor(a, b)
__xor__(a, b)
Return the bitwise exclusive or of *a* and *b*.
Return ``a ^ b``.
Operations which work with sequences (some of them with mappings too) include:
@ -405,13 +405,18 @@ Python syntax and the functions in the :mod:`!operator` module.
+-----------------------+-------------------------+---------------------------------------+
| Division | ``a // b`` | ``floordiv(a, b)`` |
+-----------------------+-------------------------+---------------------------------------+
| Bitwise And | ``a & b`` | ``and_(a, b)`` |
| Bitwise And, or | ``a & b`` | ``and_(a, b)`` |
| Intersection | | |
+-----------------------+-------------------------+---------------------------------------+
| Bitwise Exclusive Or | ``a ^ b`` | ``xor(a, b)`` |
| Bitwise Exclusive Or, | ``a ^ b`` | ``xor(a, b)`` |
| or Symmetric | | |
| Difference | | |
+-----------------------+-------------------------+---------------------------------------+
| Bitwise Inversion | ``~ a`` | ``invert(a)`` |
| Bitwise Inversion, or | ``~ a`` | ``invert(a)`` |
| Complement | | |
+-----------------------+-------------------------+---------------------------------------+
| Bitwise Or | ``a | b`` | ``or_(a, b)`` |
| Bitwise Or, or | ``a | b`` | ``or_(a, b)`` |
| Union | | |
+-----------------------+-------------------------+---------------------------------------+
| Exponentiation | ``a ** b`` | ``pow(a, b)`` |
+-----------------------+-------------------------+---------------------------------------+