Fixed #18628 - Added methods/attributes to CBV docs. Thanks Daniel Greenfeld!

1 files changed, 56 insertions, 1 deletions

diff --git a/docs/ref/class-based-views/generic-display.txt b/docs/ref/class-based-views/generic-display.txt
index ef3bc179ee..12603ff0df 100644
--- a/docs/ref/class-based-views/generic-display.txt
+++ b/docs/ref/class-based-views/generic-display.txt
@@ -15,6 +15,8 @@ DetailView
 
     **Ancestors (MRO)**
 
+    This view inherits methods and attributes from the following views:
+
     * :class:`django.views.generic.detail.SingleObjectTemplateResponseMixin`
     * :class:`django.views.generic.base.TemplateResponseMixin`
     * :class:`django.views.generic.detail.BaseDetailView`
@@ -71,7 +73,9 @@ ListView
     objects (usually, but not necessarily a queryset) that the view is
     operating upon.
 
-    **Mixins**
+    **Ancestors (MRO)**
+
+    This view inherits methods and attributes from the following views:
 
     * :class:`django.views.generic.list.ListView`
     * :class:`django.views.generic.list.MultipleObjectTemplateResponseMixin`
@@ -90,3 +94,54 @@ ListView
     6. :meth:`get_context_data()`
     7. :meth:`get()`
     8. :meth:`render_to_response()`
+
+
+    **Example views.py**::
+
+        from django.views.generic.list import ListView
+        from django.utils import timezone
+
+        from articles.models import Article
+
+        class ArticleListView(ListView):
+
+            model = Article
+
+            def get_context_data(self, **kwargs):
+                context = super(ArticleListView, self).get_context_data(**kwargs)
+                context['now'] = timezone.now()
+                return context
+
+    **Example urls.py**::
+
+        from django.conf.urls import patterns, url
+
+        from article.views import ArticleListView
+
+        urlpatterns = patterns('',
+            url(r'^$', ArticleListView.as_view(), name='article-list'),
+        )
+
+.. class:: django.views.generic.list.BaseListView
+
+    A base view for displaying a list of objects. It is not intended to be used
+    directly, but rather as a parent class of the
+    :class:`django.views.generic.list.ListView` or other views representing
+    lists of objects.
+
+    **Ancestors (MRO)**
+
+    This view inherits methods and attributes from the following views:
+
+    * :class:`django.views.generic.list.MultipleObjectMixin`
+    * :class:`django.views.generic.base.View`
+
+    **Methods**
+
+    .. method:: get(request, *args, **kwargs)
+
+        Adds :attr:`object_list` to the context. If
+        :attr:`~django.views.generic.list.MultipleObjectMixin.allow_empty`
+        is True then display an empty list. If
+        :attr:`~django.views.generic.list.MultipleObjectMixin.allow_empty` is
+        False then raise a 404 error.