mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-10-31 09:41:08 +00:00
Code Issues 32 Releases Wiki Activity

[1.10.x] Fixed #27069 -- Doc'd which gettext functions may be aliased as _.

Browse Source 
Backport of 35ea6d83c8 from master
This commit is contained in:
Mattias Loverot
2016-08-16 09:38:36 +02:00
committed by Tim Graham
parent 3db01b2d58
commit 04f0c2ab39
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/topics/i18n/translation.txt
View File

@@ -70,6 +70,16 @@ as a shorter alias, ``_``, to save typing.
global ``_()`` function causes interference. Explicitly importing
``ugettext()`` as ``_()`` avoids this problem.
.. admonition:: What functions may be aliased as ``_``?
Because of how ``xgettext`` (used by :djadmin:`makemessages`) works, only
functions that take a single string argument can be imported as ``_``:
* :func:`~django.utils.translation.gettext`
* :func:`~django.utils.translation.gettext_lazy`
* :func:`~django.utils.translation.ugettext`
* :func:`~django.utils.translation.ugettext_lazy`
In this example, the text ``"Welcome to my site."`` is marked as a translation
string::