[3.6] bpo-29751: Improve PyLong_FromString documentation (GH-915) (#1266)

(cherry picked from commit 26896f2832)
This commit is contained in:
Mariatta 2017-04-23 21:05:01 -07:00 committed by GitHub
parent f2ed2858ee
commit ea0efa3bc1

View file

@ -85,13 +85,12 @@ All integers are implemented as "long" integer objects of arbitrary size.
Return a new :c:type:`PyLongObject` based on the string value in *str*, which Return a new :c:type:`PyLongObject` based on the string value in *str*, which
is interpreted according to the radix in *base*. If *pend* is non-*NULL*, is interpreted according to the radix in *base*. If *pend* is non-*NULL*,
*\*pend* will point to the first character in *str* which follows the *\*pend* will point to the first character in *str* which follows the
representation of the number. If *base* is ``0``, the radix will be representation of the number. If *base* is ``0``, *str* is interpreted using
determined based on the leading characters of *str*: if *str* starts with the :ref:`integers` definition; in this case, leading zeros in a
``'0x'`` or ``'0X'``, radix 16 will be used; if *str* starts with ``'0o'`` or non-zero decimal number raises a :exc:`ValueError`. If *base* is not ``0``,
``'0O'``, radix 8 will be used; if *str* starts with ``'0b'`` or ``'0B'``, it must be between ``2`` and ``36``, inclusive. Leading spaces and single
radix 2 will be used; otherwise radix 10 will be used. If *base* is not underscores after a base specifier and between digits are ignored. If there
``0``, it must be between ``2`` and ``36``, inclusive. Leading spaces are are no digits, :exc:`ValueError` will be raised.
ignored. If there are no digits, :exc:`ValueError` will be raised.
.. c:function:: PyObject* PyLong_FromUnicode(Py_UNICODE *u, Py_ssize_t length, int base) .. c:function:: PyObject* PyLong_FromUnicode(Py_UNICODE *u, Py_ssize_t length, int base)