diff options
author | Raymond Hettinger <python@rcn.com> | 2011-05-11 17:48:02 (GMT) |
---|---|---|
committer | Raymond Hettinger <python@rcn.com> | 2011-05-11 17:48:02 (GMT) |
commit | caece0a6a02b9677e560c92469ab6665fbcb30eb (patch) | |
tree | 4687e5fd740378fd4da59935fc38731424a8f168 | |
parent | bd85f5e7dba840ad796be398c73f6b08d49e8ef8 (diff) | |
parent | 30439b23c08761a8356cec23a4a8ff09bba35414 (diff) | |
download | cpython-caece0a6a02b9677e560c92469ab6665fbcb30eb.zip cpython-caece0a6a02b9677e560c92469ab6665fbcb30eb.tar.gz cpython-caece0a6a02b9677e560c92469ab6665fbcb30eb.tar.bz2 |
Document default fmtspec. Fix inaccurate note. Document exceptions.
-rw-r--r-- | Doc/library/functions.rst | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index 3020128..8b7eef5 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -498,11 +498,14 @@ are always available. They are listed here in alphabetical order. of the *value* argument, however there is a standard formatting syntax that is used by most built-in types: :ref:`formatspec`. - .. note:: - - ``format(value, format_spec)`` merely calls - ``value.__format__(format_spec)``. - + The default *format_spec* is an empty string which usually gives the same + effect as calling ``str(value)``. + + A call to ``format(value, format_spec)`` is translated to + ``type(value).__format__(format_spec)`` which bypasses the instance + dictionary when searching for the value's :meth:`__format__` method. A + :exc:`TypeError` exception is raised if the method is not found or if either + the *format_spec* or the return value are not strings. .. function:: frozenset([iterable]) :noindex: |