gh-87281: Improve documentation for locale.setlocale() and locale.getlocale() #137313
Conversation
|
Reference to RFC 1766 was incorrect -- RFC 1766 specifies language and territory separated by a minus instead of underscore, and it does not contain much useful information anyway. Also,
Added specification of universally accepted formats. Late |
Doc/library/locale.rst
Outdated
| name using the locale aliasing engine. An empty string specifies the user's | ||
| default settings. If the modification of the locale fails, the exception | ||
| :exc:`Error` is raised. If successful, the new locale setting is returned. | ||
|
|
||
| The format of the *locale* and the language code strings is platform | ||
| depended, but the forms ``language[_territory][.encoding][@modifier]`` | ||
| and ``language[_territory]`` respectively are typically accepted on all |
There was a problem hiding this comment.
| and ``language[_territory]`` respectively are typically accepted on all | |
| and ``language[_territory]`` are typically accepted on all |
I'm not sure what this is referring to?
There was a problem hiding this comment.
It refers to the locale and the language code strings.
There was a problem hiding this comment.
If this is not clear, we can only specify format for locale, and then say that the language code has the same format, but without encoding and modifier (support for modifiers will be added in #137253).
There was a problem hiding this comment.
I'd write: "the form language[_territory][.encoding][@modifier] is typically accepted".
The second version you mention is already included in this.
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Doc/library/locale.rst
Outdated
| name using the locale aliasing engine. An empty string specifies the user's | ||
| default settings. If the modification of the locale fails, the exception | ||
| :exc:`Error` is raised. If successful, the new locale setting is returned. | ||
|
|
||
| The format of the *locale* and the language code strings is platform | ||
| depended, but the forms ``language[_territory][.encoding][@modifier]`` | ||
| and ``language[_territory]`` respectively are typically accepted on all |
There was a problem hiding this comment.
It refers to the locale and the language code strings.
Doc/library/locale.rst
Outdated
| name using the locale aliasing engine. An empty string specifies the user's | ||
| default settings. If the modification of the locale fails, the exception | ||
| :exc:`Error` is raised. If successful, the new locale setting is returned. | ||
|
|
||
| The format of the *locale* and the language code strings is platform | ||
| depended, but the forms ``language[_territory][.encoding][@modifier]`` | ||
| and ``language[_territory]`` respectively are typically accepted on all |
There was a problem hiding this comment.
I'd write: "the form language[_territory][.encoding][@modifier] is typically accepted".
The second version you mention is already included in this.
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
📚 Documentation preview 📚: https://cpython-previews--137313.org.readthedocs.build/