From 57491e0703ab46f6f4f43e534750611d96be1aa2 Mon Sep 17 00:00:00 2001 From: Chris Jerdonek Date: Fri, 28 Sep 2012 00:10:44 -0700 Subject: Issue #16036: Improve documentation of built-in int()'s signature and arguments. --- Doc/library/functions.rst | 21 +++++++++++++-------- Misc/NEWS | 3 +++ 2 files changed, 16 insertions(+), 8 deletions(-) diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index 17a0d1b..1ee8540 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -627,14 +627,19 @@ are always available. They are listed here in alphabetical order. to provide elaborate line editing and history features. -.. function:: int([number | string[, base]]) - - Convert a number or string to an integer. If no arguments are given, return - ``0``. If a number is given, return ``number.__int__()``. Conversion of - floating point numbers to integers truncates towards zero. A string must be - a base-radix integer literal optionally preceded by '+' or '-' (with no space - in between) and optionally surrounded by whitespace. A base-n literal - consists of the digits 0 to n-1, with 'a' to 'z' (or 'A' to 'Z') having +.. function:: int(x=0) + int(x, base=10) + + Convert a number or string *x* to an integer, or return ``0`` if no + arguments are given. If *x* is a number, return :meth:`x.__int__() + `. 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 ` 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 diff --git a/Misc/NEWS b/Misc/NEWS index 485b73f..26d0134 100644 --- a/Misc/NEWS +++ b/Misc/NEWS @@ -591,6 +591,9 @@ Build Documentation ------------- +- Issue #16036: Improve documentation of built-in int()'s signature and + arguments. + - Issue #15935: Clarification of argparse docs, re: add_argument() type and default arguments. Patch contributed by Chris Jerdonek. -- cgit v0.12