summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/urls.txt9
1 files changed, 8 insertions, 1 deletions
diff --git a/docs/ref/urls.txt b/docs/ref/urls.txt
index 6bf8c1effe..37df9a30cf 100644
--- a/docs/ref/urls.txt
+++ b/docs/ref/urls.txt
@@ -25,11 +25,18 @@ Helper function to return a URL pattern for serving files in debug mode::
``urlpatterns`` should be a list of ``url()`` instances. For example::
+ from django.conf.urls import include, url
+
urlpatterns = [
- url(r'^index/$', index_view, name="main-view"),
+ url(r'^index/$', index_view, name='main-view'),
+ url(r'^weblog/', include('blog.urls')),
...
]
+The ``view`` parameter is a view function or the result of
+:meth:`~django.views.generic.base.View.as_view` for class-based views. It can
+also be an :func:`include`.
+
The ``kwargs`` parameter allows you to pass additional arguments to the view
function or method. See :ref:`views-extra-options` for an example.