Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

[1.6.x] Fixed #21372 -- Corrected docs regarding translating LANGUAGES.

Corrected LANGUAGES documentation on how to translate language
names. Now using django.utils.translation.ugettext_lazy instead
of a dummy gettext() function.

Thanks to Salvatore for the report.

Backport of 8bc350b from master.
  • Loading branch information...
commit 4aed1ee339c4a36035e1fd1a02b1ec9142feac07 1 parent 4b9e932
@bernardopires bernardopires authored bmispelon committed
Showing with 14 additions and 34 deletions.
  1. +7 −17 docs/ref/settings.txt
  2. +7 −17 docs/topics/i18n/translation.txt
View
24 docs/ref/settings.txt
@@ -1325,29 +1325,19 @@ This specifies which languages are available for language selection. See
Generally, the default value should suffice. Only set this setting if you want
to restrict language selection to a subset of the Django-provided languages.
-If you define a custom :setting:`LANGUAGES` setting, it's OK to mark the
-languages as translation strings (as in the default value referred to above)
--- but use a "dummy" ``gettext()`` function, not the one in
-``django.utils.translation``. You should *never* import
-``django.utils.translation`` from within your settings file, because that
-module in itself depends on the settings, and that would cause a circular
-import.
+If you define a custom :setting:`LANGUAGES` setting, you can mark the
+language names as translation strings using the
+:func:`~django.utils.translation.ugettext_lazy` function.
-The solution is to use a "dummy" ``gettext()`` function. Here's a sample
-settings file::
+Here's a sample settings file::
- gettext = lambda s: s
+ from django.utils.translation import ugettext_lazy as _
LANGUAGES = (
- ('de', gettext('German')),
- ('en', gettext('English')),
+ ('de', _('German')),
+ ('en', _('English')),
)
-With this arrangement, ``django-admin.py makemessages`` will still find and
-mark these strings for translation, but the translation won't happen at
-runtime -- so you'll have to remember to wrap the languages in the *real*
-``gettext()`` in any code that uses :setting:`LANGUAGES` at runtime.
-
.. setting:: LOCALE_PATHS
LOCALE_PATHS
View
24 docs/topics/i18n/translation.txt
@@ -1624,29 +1624,19 @@ Notes:
en-us).
* If you define a custom :setting:`LANGUAGES` setting, as explained in the
- previous bullet, it's OK to mark the languages as translation strings
- -- but use a "dummy" ``ugettext()`` function, not the one in
- ``django.utils.translation``. You should *never* import
- ``django.utils.translation`` from within your settings file, because that
- module in itself depends on the settings, and that would cause a circular
- import.
+ previous bullet, you can mark the language names as translation strings
+ -- but use :func:`~django.utils.translation.ugettext_lazy` instead of
+ :func:`~django.utils.translation.ugettext` to avoid a circular import.
- The solution is to use a "dummy" ``ugettext()`` function. Here's a sample
- settings file::
+ Here's a sample settings file::
- ugettext = lambda s: s
+ from django.utils.translation import ugettext_lazy as _
LANGUAGES = (
- ('de', ugettext('German')),
- ('en', ugettext('English')),
+ ('de', _('German')),
+ ('en', _('English')),
)
- With this arrangement, :djadmin:`django-admin.py makemessages <makemessages>`
- will still find and mark these strings for translation, but the translation
- won't happen at runtime -- so you'll have to remember to wrap the languages in
- the *real* ``ugettext()`` in any code that uses :setting:`LANGUAGES` at
- runtime.
-
Once ``LocaleMiddleware`` determines the user's preference, it makes this
preference available as ``request.LANGUAGE_CODE`` for each
:class:`~django.http.HttpRequest`. Feel free to read this value in your view

0 comments on commit 4aed1ee

Please sign in to comment.
Something went wrong with that request. Please try again.