summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Martin <tim@asymptotic.co.uk>2014-03-25 21:06:54 +0000
committerTim Graham <timograham@gmail.com>2014-03-27 07:02:06 -0400
commitfe83cfe9eddae67838d453fa247bd47e1b3bf277 (patch)
treeb92e7521fab85b66ef11637d6c80153686a50342
parentc0a9c2f72ac289b2ba8313c6a2c56be5ed94f01d (diff)
[1.6.x] Fixed #21941 -- Documented the kwargs param of django.conf.urls.url().
Thanks cjerdonek for the report. Backport of a779757706 from master
-rw-r--r--docs/ref/urls.txt3
-rw-r--r--docs/topics/http/urls.txt16
2 files changed, 14 insertions, 5 deletions
diff --git a/docs/ref/urls.txt b/docs/ref/urls.txt
index 78e2e28980..31d3ecab93 100644
--- a/docs/ref/urls.txt
+++ b/docs/ref/urls.txt
@@ -76,6 +76,9 @@ This function takes five arguments, most of which are optional::
url(regex, view, kwargs=None, name=None, prefix='')
+The ``kwargs`` parameter allows you to pass additional arguments to the view
+function or method. See :ref:`views-extra-options` for an example.
+
See :ref:`Naming URL patterns <naming-url-patterns>` for why the ``name``
parameter is useful.
diff --git a/docs/topics/http/urls.txt b/docs/topics/http/urls.txt
index 21084fe176..b19251dc66 100644
--- a/docs/topics/http/urls.txt
+++ b/docs/topics/http/urls.txt
@@ -51,11 +51,17 @@ algorithm the system follows to determine which Python code to execute:
3. Django runs through each URL pattern, in order, and stops at the first
one that matches the requested URL.
-4. Once one of the regexes matches, Django imports and calls the given
- view, which is a simple Python function (or a :doc:`class based view
- </topics/class-based-views/index>`). The view gets passed an
- :class:`~django.http.HttpRequest` as its first argument and any values
- captured in the regex as remaining arguments.
+4. Once one of the regexes matches, Django imports and calls the given view,
+ which is a simple Python function (or a :doc:`class based view
+ </topics/class-based-views/index>`). The view gets passed the following
+ arguments:
+
+ * An instance of :class:`~django.http.HttpRequest`.
+ * If the matched regular expression returned no named groups, then the
+ matches from the regular expression are provided as positional arguments.
+ * The keyword arguments are made up of any named groups matched by the
+ regular expression, overridden by any arguments specified in the optional
+ ``kwargs`` argument to :func:`django.conf.urls.url`.
5. If no regex matches, or if an exception is raised during any
point in this process, Django invokes an appropriate