mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-28 11:15:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

[3.12] gh-101100: Fix Sphinx warning in library/gettext.rst (GH-112668) (#112674)

Browse source 
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
This commit is contained in:
Hugo van Kemenade 2023-12-03 22:32:57 +02:00 • committed by GitHub
parent 5608112fa9
commit da73a5cc27
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

14
Doc/library/gettext.rst
View file

@ -257,7 +257,7 @@ are the methods of :class:`!NullTranslations`:
.. method:: info() .. method:: info()
Return the "protected" :attr:`_info` variable, a dictionary containing Return a dictionary containing
the metadata found in the message catalog file. the metadata found in the message catalog file.
@ -296,9 +296,9 @@ are the methods of :class:`!NullTranslations`:
The :class:`GNUTranslations` class The :class:`GNUTranslations` class
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The :mod:`gettext` module provides one additional class derived from The :mod:`!gettext` module provides one additional class derived from
:class:`NullTranslations`: :class:`GNUTranslations`. This class overrides :class:`NullTranslations`: :class:`GNUTranslations`. This class overrides
:meth:`_parse` to enable reading GNU :program:`gettext` format :file:`.mo` files :meth:`!_parse` to enable reading GNU :program:`gettext` format :file:`.mo` files
in both big-endian and little-endian format. in both big-endian and little-endian format.
:class:`GNUTranslations` parses optional metadata out of the translation :class:`GNUTranslations` parses optional metadata out of the translation
@ -306,7 +306,7 @@ catalog. It is convention with GNU :program:`gettext` to include metadata as
the translation for the empty string. This metadata is in :rfc:`822`\ -style the translation for the empty string. This metadata is in :rfc:`822`\ -style
``key: value`` pairs, and should contain the ``Project-Id-Version`` key. If the ``key: value`` pairs, and should contain the ``Project-Id-Version`` key. If the
key ``Content-Type`` is found, then the ``charset`` property is used to key ``Content-Type`` is found, then the ``charset`` property is used to
initialize the "protected" :attr:`_charset` instance variable, defaulting to initialize the "protected" :attr:`!_charset` instance variable, defaulting to
``None`` if not found. If the charset encoding is specified, then all message ``None`` if not found. If the charset encoding is specified, then all message
ids and message strings read from the catalog are converted to Unicode using ids and message strings read from the catalog are converted to Unicode using
this encoding, else ASCII is assumed. this encoding, else ASCII is assumed.
@ -315,7 +315,7 @@ Since message ids are read as Unicode strings too, all ``*gettext()`` methods
will assume message ids as Unicode strings, not byte strings. will assume message ids as Unicode strings, not byte strings.
The entire set of key/value pairs are placed into a dictionary and set as the The entire set of key/value pairs are placed into a dictionary and set as the
"protected" :attr:`_info` instance variable. "protected" :attr:`!_info` instance variable.
If the :file:`.mo` file's magic number is invalid, the major version number is If the :file:`.mo` file's magic number is invalid, the major version number is
unexpected, or if other problems occur while reading the file, instantiating a unexpected, or if other problems occur while reading the file, instantiating a
@ -636,9 +636,9 @@ implementations, and valuable experience to the creation of this module:
.. rubric:: Footnotes .. rubric:: Footnotes
.. [#] The default locale directory is system dependent; for example, on RedHat Linux .. [#] The default locale directory is system dependent; for example, on Red Hat Linux
it is :file:`/usr/share/locale`, but on Solaris it is :file:`/usr/lib/locale`. it is :file:`/usr/share/locale`, but on Solaris it is :file:`/usr/lib/locale`.
The :mod:`gettext` module does not try to support these system dependent The :mod:`!gettext` module does not try to support these system dependent
defaults; instead its default is :file:`{sys.base_prefix}/share/locale` (see defaults; instead its default is :file:`{sys.base_prefix}/share/locale` (see
:data:`sys.base_prefix`). For this reason, it is always best to call :data:`sys.base_prefix`). For this reason, it is always best to call
:func:`bindtextdomain` with an explicit absolute path at the start of your :func:`bindtextdomain` with an explicit absolute path at the start of your

1
Doc/tools/.nitignore
View file

@ -67,7 +67,6 @@ Doc/library/ftplib.rst
Doc/library/functions.rst Doc/library/functions.rst
Doc/library/functools.rst Doc/library/functools.rst
Doc/library/getopt.rst Doc/library/getopt.rst
Doc/library/gettext.rst
Doc/library/http.client.rst Doc/library/http.client.rst
Doc/library/http.cookiejar.rst Doc/library/http.cookiejar.rst
Doc/library/http.cookies.rst Doc/library/http.cookies.rst