Merge remote-tracking branch 'upstream/main' into remove-deprecated-t…

…runc-delegation
python · mdickinson · Jun 2, 2024 · May 29, 2024 · May 29, 2024 · May 29, 2024
commit 4a479abc44b9fbd88f9151e06943a2d22c63d65d
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
@@ -983,10 +983,29 @@ are always available.  They are listed here in alphabetical order.
 .. class:: int(number=0, /)
            int(string, /, base=10)
 
-   Return an integer object constructed from a number or string *x*, or return
-   ``0`` if no arguments are given.  If *x* defines :meth:`~object.__int__`,
-   ``int(x)`` returns ``x.__int__()``.  If *x* defines :meth:`~object.__index__`,
-   it returns ``x.__index__()``.
+   Return an integer object constructed from a number or a string, or return
+   ``0`` if no arguments are given.
+
+   Examples:
+
+   .. doctest::
+
+      >>> int(123.45)
+      123
+      >>> int('123')
+      123
+      >>> int('   -12_345\n')
+      -12345
+      >>> int('FACE', 16)
+      64206
+      >>> int('0xface', 0)
+      64206
+      >>> int('01110011', base=2)
+      115
+
+   If the argument defines :meth:`~object.__int__`,
+   ``int(x)`` returns ``x.__int__()``.  If the argument defines
+   :meth:`~object.__index__`, it returns ``x.__index__()``.
    For floating point numbers, this truncates towards zero.
 
    If the argument is not a number or if *base* is given, then it must be a string,