From: Georg Brandl <georg@python.org>
Date: Mon, 23 Feb 2009 10:24:23 +0000 (+0000)
Subject: #5348: format() converts all kinds of values.
X-Git-Tag: v2.7a1~1962
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=528f8810aa495d2efc50af7ceb28d2c7092ea92e;p=python

#5348: format() converts all kinds of values.
---

diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 3789e202ce..0232e1bddc 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -425,6 +425,26 @@ available.  They are listed here in alphabetical order.
 
    The float type is described in :ref:`typesnumeric`.
 
+
+.. function:: format(value[, format_spec])
+
+   .. index::
+      pair: str; format
+      single: __format__
+
+   Convert a *value* to a "formatted" representation, as controlled by
+   *format_spec*.  The interpretation of *format_spec* will depend on the type
+   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)``.
+
+   .. versionadded:: 2.6
+
+
 .. function:: frozenset([iterable])
    :noindex: