Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bpo-10379: Add %char examples to locale.format() docs #1145

Merged
merged 1 commit into from
Apr 20, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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