[New-bugs-announce] [issue17210] documentation of PyUnicode_Format() states wrong argument type requirements

[Stefan Behnel]

New submission from Stefan Behnel:

The current documentation says:

"""
PyObject* PyUnicode_Format(PyObject *format, PyObject *args)
    Return value: New reference.

    Return a new string object from format and args; this is analogous to format % args. The args argument must be a tuple.
"""

According to the implementation, however, "args" can be a tuple, a unicode string, or an arbitrary mapping, i.e. everything that Python's "%" operator allows for strings as well.

----------
assignee: docs at python
components: Documentation
messages: 182140
nosy: docs at python, scoder
priority: normal
severity: normal
status: open
title: documentation of PyUnicode_Format() states wrong argument type requirements
type: behavior
versions: Python 2.6, Python 2.7, Python 3.2, Python 3.3, Python 3.4

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue17210>
_______________________________________