Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

minor edits to locale doc (#98537)

This commit is contained in:
Skip Montanaro 2022-11-04 08:02:11 -05:00 committed by GitHub
parent 2844aa6a8e
commit c0bf7607a1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
Doc/library/locale.rst
View File

@ -147,12 +147,12 @@ The :mod:`locale` module defines the following exception and functions:
| ``CHAR_MAX`` | Nothing is specified in this locale. | | ``CHAR_MAX`` | Nothing is specified in this locale. |
+--------------+-----------------------------------------+ +--------------+-----------------------------------------+
The function sets temporarily the ``LC_CTYPE`` locale to the ``LC_NUMERIC`` The function temporarily sets the ``LC_CTYPE`` locale to the ``LC_NUMERIC``
locale or the ``LC_MONETARY`` locale if locales are different and numeric or locale or the ``LC_MONETARY`` locale if locales are different and numeric or
monetary strings are non-ASCII. This temporary change affects other threads. monetary strings are non-ASCII. This temporary change affects other threads.
.. versionchanged:: 3.7 .. versionchanged:: 3.7
The function now sets temporarily the ``LC_CTYPE`` locale to the The function now temporarily sets the ``LC_CTYPE`` locale to the
``LC_NUMERIC`` locale in some cases. ``LC_NUMERIC`` locale in some cases.
@ -227,16 +227,18 @@ The :mod:`locale` module defines the following exception and functions:
Get a regular expression that can be used with the regex function to Get a regular expression that can be used with the regex function to
recognize a positive response to a yes/no question. recognize a positive response to a yes/no question.
.. note::
The expression is in the syntax suitable for the :c:func:`regex` function
from the C library, which might differ from the syntax used in :mod:`re`.
.. data:: NOEXPR .. data:: NOEXPR
Get a regular expression that can be used with the regex(3) function to Get a regular expression that can be used with the regex(3) function to
recognize a negative response to a yes/no question. recognize a negative response to a yes/no question.
.. note::
The regular expressions for :const:`YESEXPR` and
:const:`NOEXPR` use syntax suitable for the
:c:func:`regex` function from the C library, which might
differ from the syntax used in :mod:`re`.
.. data:: CRNCYSTR .. data:: CRNCYSTR
Get the currency symbol, preceded by "-" if the symbol should appear before Get the currency symbol, preceded by "-" if the symbol should appear before
@ -399,7 +401,7 @@ The :mod:`locale` module defines the following exception and functions:
Formats a number *val* according to the current :const:`LC_NUMERIC` setting. Formats a number *val* according to the current :const:`LC_NUMERIC` setting.
The format follows the conventions of the ``%`` operator. For floating point The format follows the conventions of the ``%`` operator. For floating point
values, the decimal point is modified if appropriate. If *grouping* is true, values, the decimal point is modified if appropriate. If *grouping* is ``True``,
also takes the grouping into account. also takes the grouping into account.
If *monetary* is true, the conversion uses monetary thousands separator and If *monetary* is true, the conversion uses monetary thousands separator and
@ -417,12 +419,14 @@ The :mod:`locale` module defines the following exception and functions:
Formats a number *val* according to the current :const:`LC_MONETARY` settings. Formats a number *val* according to the current :const:`LC_MONETARY` settings.
The returned string includes the currency symbol if *symbol* is true, which is The returned string includes the currency symbol if *symbol* is true, which is
the default. If *grouping* is true (which is not the default), grouping is done the default. If *grouping* is ``True`` (which is not the default), grouping is done
with the value. If *international* is true (which is not the default), the with the value. If *international* is ``True`` (which is not the default), the
international currency symbol is used. international currency symbol is used.
Note that this function will not work with the 'C' locale, so you have to set a .. note::
locale via :func:`setlocale` first.
This function will not work with the 'C' locale, so you have to set a
locale via :func:`setlocale` first.
.. function:: str(float) .. function:: str(float)
@ -609,4 +613,3 @@ applications that link with additional C libraries which internally invoke
:c:func:`gettext` or :c:func:`dcgettext`. For these applications, it may be :c:func:`gettext` or :c:func:`dcgettext`. For these applications, it may be
necessary to bind the text domain, so that the libraries can properly locate necessary to bind the text domain, so that the libraries can properly locate
their message catalogs. their message catalogs.