Skip to content

gh-140553: Mark *gettext parameters as positionaly only in documentation #140598

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

gh-140553: Mark *gettext parameters as positionaly only in documentation #140598

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions Doc/library/gettext.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,19 +54,19 @@ class-based API instead.


.. index:: single: _ (underscore); gettext
.. function:: gettext(message)
.. function:: gettext(message, /)

Return the localized translation of *message*, based on the current global
domain, language, and locale directory. This function is usually aliased as
:func:`!_` in the local namespace (see examples below).


.. function:: dgettext(domain, message)
.. function:: dgettext(domain, message, /)

Like :func:`.gettext`, but look the message up in the specified *domain*.


.. function:: ngettext(singular, plural, n)
.. function:: ngettext(singular, plural, n, /)

Like :func:`.gettext`, but consider plural forms. If a translation is found,
apply the plural formula to *n*, and return the resulting message (some
Expand All @@ -81,15 +81,15 @@ class-based API instead.
formulas for a variety of languages.


.. function:: dngettext(domain, singular, plural, n)
.. function:: dngettext(domain, singular, plural, n, /)

Like :func:`ngettext`, but look the message up in the specified *domain*.


.. function:: pgettext(context, message)
.. function:: dpgettext(domain, context, message)
.. function:: npgettext(context, singular, plural, n)
.. function:: dnpgettext(domain, context, singular, plural, n)
.. function:: pgettext(context, message, /)
.. function:: dpgettext(domain, context, message, /)
.. function:: npgettext(context, singular, plural, n, /)
.. function:: dnpgettext(domain, context, singular, plural, n, /)

Similar to the corresponding functions without the ``p`` in the prefix (that
is, :func:`gettext`, :func:`dgettext`, :func:`ngettext`, :func:`dngettext`),
Expand Down Expand Up @@ -226,28 +226,28 @@ are the methods of :class:`!NullTranslations`:
translation for a given message.


.. method:: gettext(message)
.. method:: gettext(message, /)

If a fallback has been set, forward :meth:`!gettext` to the fallback.
Otherwise, return *message*. Overridden in derived classes.


.. method:: ngettext(singular, plural, n)
.. method:: ngettext(singular, plural, n, /)

If a fallback has been set, forward :meth:`!ngettext` to the fallback.
Otherwise, return *singular* if *n* is 1; return *plural* otherwise.
Overridden in derived classes.


.. method:: pgettext(context, message)
.. method:: pgettext(context, message, /)

If a fallback has been set, forward :meth:`pgettext` to the fallback.
Otherwise, return the translated message. Overridden in derived classes.

.. versionadded:: 3.8


.. method:: npgettext(context, singular, plural, n)
.. method:: npgettext(context, singular, plural, n, /)

If a fallback has been set, forward :meth:`npgettext` to the fallback.
Otherwise, return the translated message. Overridden in derived classes.
Expand Down Expand Up @@ -325,7 +325,7 @@ unexpected, or if other problems occur while reading the file, instantiating a

The following methods are overridden from the base class implementation:

.. method:: gettext(message)
.. method:: gettext(message, /)

Look up the *message* id in the catalog and return the corresponding message
string, as a Unicode string. If there is no entry in the catalog for the
Expand All @@ -334,7 +334,7 @@ unexpected, or if other problems occur while reading the file, instantiating a
*message* id is returned.


.. method:: ngettext(singular, plural, n)
.. method:: ngettext(singular, plural, n, /)

Do a plural-forms lookup of a message id. *singular* is used as the message id
for purposes of lookup in the catalog, while *n* is used to determine which
Expand All @@ -355,7 +355,7 @@ unexpected, or if other problems occur while reading the file, instantiating a
n) % {'num': n}


.. method:: pgettext(context, message)
.. method:: pgettext(context, message, /)

Look up the *context* and *message* id in the catalog and return the
corresponding message string, as a Unicode string. If there is no
Expand All @@ -366,7 +366,7 @@ unexpected, or if other problems occur while reading the file, instantiating a
.. versionadded:: 3.8


.. method:: npgettext(context, singular, plural, n)
.. method:: npgettext(context, singular, plural, n, /)

Do a plural-forms lookup of a message id. *singular* is used as the
message id for purposes of lookup in the catalog, while *n* is used to
Expand Down
Loading