From 6dbdedb0b18a5ca850ab8ce512fda24d5a9d0688 Mon Sep 17 00:00:00 2001 From: Berker Peksag Date: Thu, 20 Apr 2017 07:38:43 +0300 Subject: [PATCH] bpo-10379: Add %char examples to locale.format() docs (GH-1145) --- Doc/library/locale.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/Doc/library/locale.rst b/Doc/library/locale.rst index 181f534abe2..69959a3451e 100644 --- a/Doc/library/locale.rst +++ b/Doc/library/locale.rst @@ -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)