Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Documented `translation.override` context manager introduced in r16166.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@16685 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit b0764e81ad04d5bd31ff99838445761503bb3526 1 parent 7e66cca
Jannis Leidel jezdez authored
Showing with 12 additions and 3 deletions.
  1. +12 −3 docs/ref/utils.txt
15 docs/ref/utils.txt
View
@@ -523,9 +523,8 @@ For a complete discussion on the usage of the following see the
.. function:: activate(language)
- Fetches the translation object for a given tuple of application name and
- language and installs it as the current translation object for the current
- thread.
+ Fetches the translation object for a given language and installs it as
+ the current translation object for the current thread.
.. function:: deactivate()
@@ -538,6 +537,16 @@ For a complete discussion on the usage of the following see the
useful when we want delayed translations to appear as the original string
for some reason.
+.. function:: override(language)
+
+ .. versionadded:: 1.4
+
+ A Python context manager that uses
+ :func:`django.utils.translation.activate` to fetch the translation object
+ for a given language, installing it as the translation object for the
+ current thread and deinstalls it again on exit with
+ :func:`django.utils.translation.deactivate`.
+
.. function:: get_language()
Returns the currently selected language code.
Please sign in to comment.
Something went wrong with that request. Please try again.