From: Mark Dickinson <mdickinson@enthought.com>
Date: Tue, 11 Oct 2011 17:06:36 +0000 (+0100)
Subject: Issue #13145. Fix incorrect documentation for PyNumber_ToBase.  Thanks Sven Marnach.
X-Git-Tag: v3.2.3rc1~510
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f1ab47ebc4d6f6cdb0ea7f9ec73d874aae03a1f2;p=thirdparty%2FPython%2Fcpython.git

Issue #13145. Fix incorrect documentation for PyNumber_ToBase.  Thanks Sven Marnach.
---

diff --git a/Doc/c-api/number.rst b/Doc/c-api/number.rst
index 090fc649f172..21951c38c0df 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.