summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMariusz Felisiak <felisiak.mariusz@gmail.com>2022-01-10 12:16:15 +0100
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2022-01-10 13:31:25 +0100
commitdfda5ff7226c2719750fc06e633ec7234c23b300 (patch)
tree5cf3d96d431eecc1924d68e7b205cf906f20297f /docs
parent6554f00df6cfe3be7d843025a3f53fe124cfd756 (diff)
[4.0.x] Corrected signatures of some functions in docs.
Backport of 178109c1734ccc16386c3e3cbae1465c7a1b8ed8 from main
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/templates/api.txt10
-rw-r--r--docs/topics/cache.txt2
-rw-r--r--docs/topics/i18n/translation.txt2
-rw-r--r--docs/topics/testing/tools.txt4
4 files changed, 9 insertions, 9 deletions
diff --git a/docs/ref/templates/api.txt b/docs/ref/templates/api.txt
index 7e9812fffb..1082823e71 100644
--- a/docs/ref/templates/api.txt
+++ b/docs/ref/templates/api.txt
@@ -654,7 +654,7 @@ Here's what each of the built-in processors does:
``django.contrib.auth.context_processors.auth``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. function:: auth
+.. function:: auth(request)
If this processor is enabled, every ``RequestContext`` will contain these
variables:
@@ -672,7 +672,7 @@ variables:
``django.template.context_processors.debug``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. function:: debug
+.. function:: debug(request)
If this processor is enabled, every ``RequestContext`` will contain these two
variables -- but only if your :setting:`DEBUG` setting is set to ``True`` and
@@ -689,7 +689,7 @@ the request's IP address (``request.META['REMOTE_ADDR']``) is in the
``django.template.context_processors.i18n``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. function:: i18n
+.. function:: i18n(request)
If this processor is enabled, every ``RequestContext`` will contain these
variables:
@@ -713,7 +713,7 @@ If this processor is enabled, every ``RequestContext`` will contain a variable
``django.template.context_processors.static``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. function:: static
+.. function:: static(request)
If this processor is enabled, every ``RequestContext`` will contain a variable
``STATIC_URL``, providing the value of the :setting:`STATIC_URL` setting.
@@ -734,7 +734,7 @@ If this processor is enabled, every ``RequestContext`` will contain a variable
``django.template.context_processors.tz``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. function:: tz
+.. function:: tz(request)
If this processor is enabled, every ``RequestContext`` will contain a variable
``TIME_ZONE``, providing the name of the currently active time zone.
diff --git a/docs/topics/cache.txt b/docs/topics/cache.txt
index 3bc35fd51d..6d75247619 100644
--- a/docs/topics/cache.txt
+++ b/docs/topics/cache.txt
@@ -657,7 +657,7 @@ __ `Controlling cache: Using other headers`_
The per-view cache
==================
-.. function:: django.views.decorators.cache.cache_page
+.. function:: django.views.decorators.cache.cache_page(timeout, *, cache=None, key_prefix=None)
A more granular way to use the caching framework is by caching the output of
individual views. ``django.views.decorators.cache`` defines a ``cache_page``
diff --git a/docs/topics/i18n/translation.txt b/docs/topics/i18n/translation.txt
index 99fc41ebb6..bc10ce73cf 100644
--- a/docs/topics/i18n/translation.txt
+++ b/docs/topics/i18n/translation.txt
@@ -515,7 +515,7 @@ And then later::
Localized names of languages
----------------------------
-.. function:: get_language_info
+.. function:: get_language_info(lang_code)
The ``get_language_info()`` function provides detailed information about
languages::
diff --git a/docs/topics/testing/tools.txt b/docs/topics/testing/tools.txt
index 35a78a3897..1b6f7e0ac4 100644
--- a/docs/topics/testing/tools.txt
+++ b/docs/topics/testing/tools.txt
@@ -1295,7 +1295,7 @@ For each action, you can supply either a list of values or a string. When the
value already exists in the list, ``append`` and ``prepend`` have no effect;
neither does ``remove`` when the value doesn't exist.
-.. function:: override_settings
+.. function:: override_settings(**kwargs)
In case you want to override a setting for a test method, Django provides the
:func:`~django.test.override_settings` decorator (see :pep:`318`). It's used
@@ -1321,7 +1321,7 @@ The decorator can also be applied to :class:`~django.test.TestCase` classes::
response = self.client.get('/sekrit/')
self.assertRedirects(response, '/other/login/?next=/sekrit/')
-.. function:: modify_settings
+.. function:: modify_settings(*args, **kwargs)
Likewise, Django provides the :func:`~django.test.modify_settings`
decorator::