[docs] [issue13145] Documentation of PyNumber_ToBase() wrong

Sven Marnach report at bugs.python.org
Mon Oct 10 15:26:15 CEST 2011

New submission from Sven Marnach <sven at marnach.net>:

The documentation of PyNumber_ToBase() [1] states

    When base is not 2, 8, 10, or 16, the format is 'x#num'
    where x is the base.

In reality, the function does not accept any bases different
from 2, 8, 10, or 16, as can be seen in the source code of 
_PyLong_Form() [2], which is called from PyNumber_ToBase() to
do the actual conversion.

The patch fixes the documentation.

[1]: http://docs.python.org/c-api/number.html#PyNumber_ToBase
[2]: http://hg.python.org/cpython/file/f924e0f62bcb/Objects/longobject.c#l1663

assignee: docs at python
components: Documentation
files: pynumber-tobase-doc.patch
keywords: patch
messages: 145297
nosy: docs at python, smarnach
priority: normal
severity: normal
status: open
title: Documentation of PyNumber_ToBase() wrong
Added file: http://bugs.python.org/file23367/pynumber-tobase-doc.patch

Python tracker <report at bugs.python.org>

More information about the docs mailing list