diff options
| author | Mark Dickinson <mdickinson@enthought.com> | 2011-10-11 17:06:36 (GMT) |
|---|---|---|
| committer | Mark Dickinson <mdickinson@enthought.com> | 2011-10-11 17:06:36 (GMT) |
| commit | f1ab47ebc4d6f6cdb0ea7f9ec73d874aae03a1f2 (patch) | |
| tree | 290387c27b9f881e8a89d57d1e957ab4e43a0b6c | |
| parent | 4e1582864053476cc1136cc1b05a6f0d47f4ebb5 (diff) | |
| download | cpython-f1ab47ebc4d6f6cdb0ea7f9ec73d874aae03a1f2.zip cpython-f1ab47ebc4d6f6cdb0ea7f9ec73d874aae03a1f2.tar.gz cpython-f1ab47ebc4d6f6cdb0ea7f9ec73d874aae03a1f2.tar.bz2 | |
Issue #13145. Fix incorrect documentation for PyNumber_ToBase. Thanks Sven Marnach.
| -rw-r--r-- | Doc/c-api/number.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Doc/c-api/number.rst b/Doc/c-api/number.rst index 090fc64..21951c3 100644 --- a/Doc/c-api/number.rst +++ b/Doc/c-api/number.rst @@ -239,10 +239,10 @@ Number Protocol .. c:function:: PyObject* PyNumber_ToBase(PyObject *n, int base) - Returns the integer *n* converted to *base* as a string with a base - marker of ``'0b'``, ``'0o'``, or ``'0x'`` if applicable. When - *base* is not 2, 8, 10, or 16, the format is ``'x#num'`` where x is the - base. If *n* is not an int object, it is converted with + Returns the integer *n* converted to base *base* as a string. The *base* + argument must be one of 2, 8, 10, or 16. For base 2, 8, or 16, the + returned string is prefixed with a base marker of ``'0b'``, ``'0o'``, or + ``'0x'``, respectively. If *n* is not a Python int, it is converted with :c:func:`PyNumber_Index` first. |