gh-134887: Add references to locale module for locale-aware number formatting references in string module docs
#134888
+13
−4
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -469,7 +469,10 @@ of a number respectively. It can be one of the following: | |
| | | this option is not supported. | | ||
| +---------+----------------------------------------------------------+ | ||
|
|
||
| For a locale-aware separator, use the ``'n'`` presentation type instead. | ||
| Note that the locale setting for numeric values must first be set using | ||
| the :mod:`locale` module, for example, | ||
| ``locale.setlocale(locale.LC_NUMERIC, 'en_US')``. | ||
|
|
||
| .. versionchanged:: 3.1 | ||
| Added the ``','`` option (see also :pep:`378`). | ||
|
|
@@ -517,7 +520,10 @@ The available integer presentation types are: | |
| +---------+----------------------------------------------------------+ | ||
| | ``'n'`` | Number. This is the same as ``'d'``, except that it uses | | ||
| | | the current locale setting to insert the appropriate | | ||
| | | digit group separators. Note that the default locale is | | ||
| | | not the system locale, and therefore, you must set, at a | | ||
| | | minimum, the ``LC_NUMERIC`` category (see the | | ||
|
There was a problem hiding this comment. This isn't true, is it? I'm referring to the wording "must set": shouldn't it be "can set". There was a problem hiding this comment. On my machine, nothing happens if I use FWIW, I'm seeing that the C locale seems to be very minimal and doesn't have a thousands separator. Since that is what the default is, instead of the system locale, the thousands separator won't be set until the user sets |
||
| | | :mod:`locale` module for more information). | | ||
| +---------+----------------------------------------------------------+ | ||
| | None | The same as ``'d'``. | | ||
| +---------+----------------------------------------------------------+ | ||
|
|
@@ -599,8 +605,11 @@ The available presentation types for :class:`float` and | |
| +---------+----------------------------------------------------------+ | ||
| | ``'n'`` | Number. This is the same as ``'g'``, except that it uses | | ||
| | | the current locale setting to insert the appropriate | | ||
| | | digit group separators for the integral part of a | | ||
| | | number. Note that the default locale is not the system | | ||
| | | locale, and therefore, you must set, at a minimum, the | | ||
| | | ``LC_NUMERIC`` category (see the :mod:`locale` module | | ||
| | | for more information). | | ||
| +---------+----------------------------------------------------------+ | ||
| | ``'%'`` | Percentage. Multiplies the number by 100 and displays | | ||
| | | in fixed (``'f'``) format, followed by a percent sign. | | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why refer to this here? At most it just belongs in the
nsection.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When I was troubleshooting why this wasn't working for me, I searched this page in the docs for "locale aware" and "locale-aware" – this was the only hit, so I put this here as well to make sure that all spots a person may learn about this in the docs include all the information to use it directly. Most people won't read the entire page in the docs before using something.