Browse Source

Fixed #26776 -- Documented url()'s view argument.

Andrew Nester 8 years ago
parent
commit
a12826bba7
1 changed files with 8 additions and 1 deletions
  1. 8 1
      docs/ref/urls.txt

+ 8 - 1
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.