Skip to content

Commit c92c551

Browse files
gh-100428: Make int documentation more accurate (GH-100436)
- Remove first link to lexical definition of integer literal, since it doesn't apply (differs in handling of leading zeros, base needs to be explicitly specified, unicode digits are allowed) - Better describe handling of leading zeros, unicode digits, underscores - Base 0 does not work exactly as like a code literal, since it allows Unicode digits. Link code literal to lexical definition of integer literal. (cherry picked from commit edfbf56) Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
1 parent 8e386de commit c92c551

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

Diff for: Doc/library/functions.rst

+15-11
Original file line numberDiff line numberDiff line change
@@ -868,17 +868,21 @@ are always available. They are listed here in alphabetical order.
868868
For floating point numbers, this truncates towards zero.
869869

870870
If *x* is not a number or if *base* is given, then *x* must be a string,
871-
:class:`bytes`, or :class:`bytearray` instance representing an :ref:`integer
872-
literal <integers>` in radix *base*. Optionally, the literal can be
873-
preceded by ``+`` or ``-`` (with no space in between) and surrounded by
874-
whitespace. A base-n literal consists of the digits 0 to n-1, with ``a``
875-
to ``z`` (or ``A`` to ``Z``) having
876-
values 10 to 35. The default *base* is 10. The allowed values are 0 and 2--36.
877-
Base-2, -8, and -16 literals can be optionally prefixed with ``0b``/``0B``,
878-
``0o``/``0O``, or ``0x``/``0X``, as with integer literals in code. Base 0
879-
means to interpret exactly as a code literal, so that the actual base is 2,
880-
8, 10, or 16, and so that ``int('010', 0)`` is not legal, while
881-
``int('010')`` is, as well as ``int('010', 8)``.
871+
:class:`bytes`, or :class:`bytearray` instance representing an integer
872+
in radix *base*. Optionally, the string can be preceded by ``+`` or ``-``
873+
(with no space in between), have leading zeros, be surrounded by whitespace,
874+
and have single underscores interspersed between digits.
875+
876+
A base-n integer string contains digits, each representing a value from 0 to
877+
n-1. The values 0--9 can be represented by any Unicode decimal digit. The
878+
values 10--35 can be represented by ``a`` to ``z`` (or ``A`` to ``Z``). The
879+
default *base* is 10. The allowed bases are 0 and 2--36. Base-2, -8, and -16
880+
strings can be optionally prefixed with ``0b``/``0B``, ``0o``/``0O``, or
881+
``0x``/``0X``, as with integer literals in code. For base 0, the string is
882+
interpreted in a similar way to an :ref:`integer literal in code <integers>`,
883+
in that the actual base is 2, 8, 10, or 16 as determined by the prefix. Base
884+
0 also disallows leading zeros: ``int('010', 0)`` is not legal, while
885+
``int('010')`` and ``int('010', 8)`` are.
882886

883887
The integer type is described in :ref:`typesnumeric`.
884888

0 commit comments

Comments
 (0)