Skip to content

Commit

Permalink
bpo-10379: Add %char examples to locale.format() docs (GH-1145)
Browse files Browse the repository at this point in the history
  • Loading branch information
berkerpeksag authored Apr 20, 2017
1 parent 8526fb7 commit 6dbdedb
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions Doc/library/locale.rst
Original file line number Diff line number Diff line change
Expand Up @@ -371,13 +371,14 @@ The :mod:`locale` module defines the following exception and functions:

.. function:: format(format, val, grouping=False, monetary=False)

Please note that this function works like format_string but will only work
for exactly one %char specifier.
Please note that this function works like :meth:`format_string` but will
only work for exactly one ``%char`` specifier. For example, ``'%f'`` and
``'%.0f'`` are both valid specifiers, but ``'%f kB'`` is not.

For whole format strings, use :func:`format_string`.

.. deprecated:: 3.7
Use :meth:`format_string` instead
Use :meth:`format_string` instead.


.. function:: currency(val, symbol=True, grouping=False, international=False)
Expand Down

0 comments on commit 6dbdedb

Please sign in to comment.