diff options
author | Mark Dickinson <mdickinson@enthought.com> | 2011-10-11 18:06:36 +0100 |
---|---|---|
committer | Mark Dickinson <mdickinson@enthought.com> | 2011-10-11 18:06:36 +0100 |
commit | ab4316cf9c9f965e4ae018e0fba7a9271007a33f (patch) | |
tree | dbbb41f00d062a34ba22d1e55432790bbbb9508f | |
parent | 510869614f47eb89e5f00316e4791a94af14c012 (diff) | |
download | cpython-ab4316cf9c9f965e4ae018e0fba7a9271007a33f.tar.gz |
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 090fc649f1..21951c38c0 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. |