From c894f215e243d9526ccc116b3ce5ec7bce3b4055 Mon Sep 17 00:00:00 2001 From: Claude Paroz Date: Wed, 7 Oct 2015 10:46:08 +0200 Subject: [PATCH] [1.9.x] Added some function links in translation docs Backport of 9a6fc9606c from master. --- docs/ref/utils.txt | 6 ++++++ docs/topics/i18n/translation.txt | 11 ++++++----- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/ref/utils.txt b/docs/ref/utils.txt index c24551b9ec7..1e55875150d 100644 --- a/docs/ref/utils.txt +++ b/docs/ref/utils.txt @@ -1128,6 +1128,12 @@ For a complete discussion on the usage of the following see the ``override`` is now usable as a function decorator. +.. function:: check_for_language(lang_code) + + Checks whether there is a global language file for the given language + code (e.g. 'fr', 'pt_BR'). This is used to decide whether a user-provided + language is available. + .. function:: get_language() Returns the currently selected language code. Returns ``None`` if diff --git a/docs/topics/i18n/translation.txt b/docs/topics/i18n/translation.txt index 9b46dfe830f..6c63a2b71a5 100644 --- a/docs/topics/i18n/translation.txt +++ b/docs/topics/i18n/translation.txt @@ -1888,14 +1888,15 @@ For example:: Calling this function with the value 'de' will give you ``"Willkommen"``, regardless of :setting:`LANGUAGE_CODE` and language set by middleware. -Functions of particular interest are ``django.utils.translation.get_language()`` -which returns the language used in the current thread, -``django.utils.translation.activate()`` which activates a translation catalog -for the current thread, and ``django.utils.translation.check_for_language()`` +Functions of particular interest are +:func:`django.utils.translation.get_language()` which returns the language used +in the current thread, :func:`django.utils.translation.activate()` which +activates a translation catalog for the current thread, and +:func:`django.utils.translation.check_for_language()` which checks if the given language is supported by Django. To help write more concise code, there is also a context manager -``django.utils.translation.override()`` that stores the current language on +:func:`django.utils.translation.override()` that stores the current language on enter and restores it on exit. With it, the above example becomes:: from django.utils import translation