summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorShantanu <12621235+hauntsaninja@users.noreply.github.com>2023-01-02 03:14:18 (GMT)
committerGitHub <noreply@github.com>2023-01-02 03:14:18 (GMT)
commitedfbf56f4ca6588dfd20b53f534a4465e43c82bd (patch)
tree36b0635e200564524c3ad1c0c49a12b0b11d3517
parentb7a68ab824249ebf053b8149ebb83cd8578781c9 (diff)
downloadcpython-edfbf56f4ca6588dfd20b53f534a4465e43c82bd.zip
cpython-edfbf56f4ca6588dfd20b53f534a4465e43c82bd.tar.gz
cpython-edfbf56f4ca6588dfd20b53f534a4465e43c82bd.tar.bz2
gh-100428: Make int documentation more accurate (#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.
-rw-r--r--Doc/library/functions.rst26
1 files changed, 15 insertions, 11 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 77ebdd0..cc71428 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -893,17 +893,21 @@ are always available. They are listed here in alphabetical order.
For floating point numbers, this truncates towards zero.
If *x* is not a number or if *base* is given, then *x* must be a string,
- :class:`bytes`, or :class:`bytearray` instance representing an :ref:`integer
- literal <integers>` in radix *base*. Optionally, the literal can be
- preceded by ``+`` or ``-`` (with no space in between) and surrounded by
- whitespace. A base-n literal consists of the digits 0 to n-1, with ``a``
- to ``z`` (or ``A`` to ``Z``) having
- values 10 to 35. The default *base* is 10. The allowed values are 0 and 2--36.
- Base-2, -8, and -16 literals can be optionally prefixed with ``0b``/``0B``,
- ``0o``/``0O``, or ``0x``/``0X``, as with integer literals in code. Base 0
- means to interpret exactly as a code literal, so that the actual base is 2,
- 8, 10, or 16, and so that ``int('010', 0)`` is not legal, while
- ``int('010')`` is, as well as ``int('010', 8)``.
+ :class:`bytes`, or :class:`bytearray` instance representing an integer
+ in radix *base*. Optionally, the string can be preceded by ``+`` or ``-``
+ (with no space in between), have leading zeros, be surrounded by whitespace,
+ and have single underscores interspersed between digits.
+
+ A base-n integer string contains digits, each representing a value from 0 to
+ n-1. The values 0--9 can be represented by any Unicode decimal digit. The
+ values 10--35 can be represented by ``a`` to ``z`` (or ``A`` to ``Z``). The
+ default *base* is 10. The allowed bases are 0 and 2--36. Base-2, -8, and -16
+ strings can be optionally prefixed with ``0b``/``0B``, ``0o``/``0O``, or
+ ``0x``/``0X``, as with integer literals in code. For base 0, the string is
+ interpreted in a similar way to an :ref:`integer literal in code <integers>`,
+ in that the actual base is 2, 8, 10, or 16 as determined by the prefix. Base
+ 0 also disallows leading zeros: ``int('010', 0)`` is not legal, while
+ ``int('010')`` and ``int('010', 8)`` are.
The integer type is described in :ref:`typesnumeric`.