summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/utils.txt9
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/ref/utils.txt b/docs/ref/utils.txt
index 0b2e386268..1755ee77b3 100644
--- a/docs/ref/utils.txt
+++ b/docs/ref/utils.txt
@@ -532,15 +532,18 @@ 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)
+.. function:: override(language, deactivate=False)
.. 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`.
+ current thread and reinstall the previous active language on exit.
+ Optionally it can simply deinstall the temporary translation on exit with
+ :func:`django.utils.translation.deactivate` if the deactivate argument is
+ True. If you pass None as the language argument, a NullTranslations()
+ instance is installed while the context is active.
.. function:: get_language()