Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Fixed #15730 - Documented the as_view() method for CBVs.

  • Loading branch information...
commit b139cfc0f7e70e37b9a31e9931c6b03b8a68e918 1 parent 3c27344
@timgraham timgraham authored
View
6 docs/ref/class-based-views/base.txt
@@ -43,6 +43,12 @@ View
**Methods**
+ .. classmethod:: as_view(**initkwargs)
+
+ Returns a callable view that takes a request and returns a response::
+
+ response = MyView.as_view(request)
@brutasse
brutasse added a note

That's not exactly the syntax. **initkwargs can be used to override attributes of the view but as_view() returns the callable and doesn't accept a request. The example should be response = MyView.as_view()(request) or with arguments, response = MyView.as_view(template_name='my_template.html')(request).

@timgraham Owner

Thanks for catching that, I'll fix it shortly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
+
.. method:: dispatch(request, *args, **kwargs)
The ``view`` part of the view -- the method that accepts a ``request``
View
9 docs/ref/class-based-views/index.txt
@@ -23,7 +23,7 @@ it is safe to store state variables on the instance (i.e., ``self.foo = 3`` is
a thread-safe operation).
A class-based view is deployed into a URL pattern using the
-:meth:`~View.as_view()` classmethod::
+:meth:`~django.views.generic.base.View.as_view()` classmethod::
urlpatterns = patterns('',
(r'^view/$', MyView.as_view(size=42)),
@@ -37,9 +37,10 @@ A class-based view is deployed into a URL pattern using the
is modified, the actions of one user visiting your view could have an
effect on subsequent users visiting the same view.
-Any argument passed into :meth:`~View.as_view()` will be assigned onto the
-instance that is used to service a request. Using the previous example,
-this means that every request on ``MyView`` is able to use ``self.size``.
+Any argument passed into :meth:`~django.views.generic.base.View.as_view()` will
+be assigned onto the instance that is used to service a request. Using the
+previous example, this means that every request on ``MyView`` is able to use
+``self.size``.
Base vs Generic views
---------------------
Please sign in to comment.
Something went wrong with that request. Please try again.