From ef346a2473376c888ff160db9623eaa9871db2ac Mon Sep 17 00:00:00 2001
From: Serhiy Storchaka <storchaka@gmail.com>
Date: Tue, 24 Oct 2017 10:59:17 +0300
Subject: [PATCH] [2.7] bpo-31667: Fix gettext related links. (GH-3860) (#4100)
* Fix incorrect links.
* Remove redundant links.
* Add signatures and index entries for gettext related
functions in the locale module.
(cherry picked from commit c02a1f4ad8fcdbffad2911c5a31c71a17a89d713)
---
Doc/library/gettext.rst | 16 ++++++++--------
Doc/library/locale.rst | 14 ++++++++++----
2 files changed, 18 insertions(+), 12 deletions(-)
diff --git a/Doc/library/gettext.rst b/Doc/library/gettext.rst
index f885afb5bef..4b4883a7e33 100644
--- a/Doc/library/gettext.rst
+++ b/Doc/library/gettext.rst
@@ -149,7 +149,7 @@ Class-based API
The class-based API of the :mod:`gettext` module gives you more flexibility and
greater convenience than the GNU :program:`gettext` API. It is the recommended
-way of localizing your Python applications and modules. :mod:`gettext` defines
+way of localizing your Python applications and modules. :mod:`!gettext` defines
a "translations" class which implements the parsing of GNU :file:`.mo` format
files, and has methods for returning either standard 8-bit strings or Unicode
strings. Instances of this "translations" class can also install themselves in
@@ -239,7 +239,7 @@ Translation classes are what actually implement the translation of original
source file message strings to translated message strings. The base class used
by all translation classes is :class:`NullTranslations`; this provides the basic
interface you can use to write your own specialized translation classes. Here
-are the methods of :class:`NullTranslations`:
+are the methods of :class:`!NullTranslations`:
.. class:: NullTranslations([fp])
@@ -268,14 +268,14 @@ are the methods of :class:`NullTranslations`:
.. method:: gettext(message)
- If a fallback has been set, forward :meth:`gettext` to the
+ If a fallback has been set, forward :meth:`!gettext` to the
fallback. Otherwise, return the translated message. Overridden in derived
classes.
.. method:: lgettext(message)
- If a fallback has been set, forward :meth:`lgettext` to the
+ If a fallback has been set, forward :meth:`!lgettext` to the
fallback. Otherwise, return the translated message. Overridden in derived
classes.
@@ -284,14 +284,14 @@ are the methods of :class:`NullTranslations`:
.. method:: ugettext(message)
- If a fallback has been set, forward :meth:`ugettext` to the
+ If a fallback has been set, forward :meth:`!ugettext` to the
fallback. Otherwise, return the translated message as a Unicode
string. Overridden in derived classes.
.. method:: ngettext(singular, plural, n)
- If a fallback has been set, forward :meth:`ngettext` to the
+ If a fallback has been set, forward :meth:`!ngettext` to the
fallback. Otherwise, return the translated message. Overridden in derived
classes.
@@ -300,7 +300,7 @@ are the methods of :class:`NullTranslations`:
.. method:: lngettext(singular, plural, n)
- If a fallback has been set, forward :meth:`lngettext` to the
+ If a fallback has been set, forward :meth:`!lngettext` to the
fallback. Otherwise, return the translated message. Overridden in derived
classes.
@@ -309,7 +309,7 @@ are the methods of :class:`NullTranslations`:
.. method:: ungettext(singular, plural, n)
- If a fallback has been set, forward :meth:`ungettext` to the fallback.
+ If a fallback has been set, forward :meth:`!ungettext` to the fallback.
Otherwise, return the translated message as a Unicode string. Overridden
in derived classes.
diff --git a/Doc/library/locale.rst b/Doc/library/locale.rst
index 0b0268537a4..e16f131b57d 100644
--- a/Doc/library/locale.rst
+++ b/Doc/library/locale.rst
@@ -552,17 +552,23 @@ library.
Access to message catalogs
--------------------------
+.. function:: gettext(msg)
+.. function:: dgettext(domain, msg)
+.. function:: dcgettext(domain, msg, category)
+.. function:: textdomain(domain)
+.. function:: bindtextdomain(domain, dir)
+
The locale module exposes the C library's gettext interface on systems that
-provide this interface. It consists of the functions :func:`gettext`,
-:func:`dgettext`, :func:`dcgettext`, :func:`textdomain`, :func:`bindtextdomain`,
-and :func:`bind_textdomain_codeset`. These are similar to the same functions in
+provide this interface. It consists of the functions :func:`!gettext`,
+:func:`!dgettext`, :func:`!dcgettext`, :func:`!textdomain`, :func:`!bindtextdomain`,
+and :func:`!bind_textdomain_codeset`. These are similar to the same functions in
the :mod:`gettext` module, but use the C library's binary format for message
catalogs, and the C library's search algorithms for locating message catalogs.
Python applications should normally find no need to invoke these functions, and
should use :mod:`gettext` instead. A known exception to this rule are
applications that link with additional C libraries which internally invoke
-:c:func:`gettext` or :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
their message catalogs.
--
2.30.9