Commits

Luke Plant committed 8b66ce5

Various small corrections to docs.

Comments (0)

Files changed (2)

 
 .. class:: Filter
 
-   This is the base class for all filters, and has provides some options:
+   This is the base class for all filters, and provides some options:
 
    * ``query_param``:
 
 
 .. class:: ChoicesFilter
 
-   This is used for fields that have 'choices' defined. The choices presented
-   will be in the order specified in 'choices'.
+   This is used for fields that have 'choices' defined (normally passed in to
+   the field constructor). The choices presented will be in the order specified
+   in 'choices'.
 
 .. class:: DateTimeFilter
 
 
      Default: 5
 
-     The maximum number of links to display. If there fewer distinct values
-     than this in the data, single values will be shown, otherwise ranges.
+     The maximum number of links to display. If there are fewer distinct values
+     than this in the data, single values will be shown, and ranges otherwise.
 
    * ``ranges``
 
 * ``__init__(field, model, params, **kwargs)``
 
   Constructor. ``field`` is the string identifying the field, ``model`` is the
-  model class, ``params`` is a QueryDict (i.e. request.GET). ``kwargs`` contains
-  any custom options specified for the filter.
+  model class, ``params`` is a QueryDict (i.e. normally request.GET). ``kwargs``
+  contains any custom options specified for the filter.
 
 * ``apply_filter(qs)``
 

docs/overview.rst

 (with BINDING_CHOICES, Author and Genre omitted for brevity).
 
 You might want to present a list of Book objects, allowing the user to filter on
-the various fields. Assuming your views.py is something like this:
+the various fields. Your views.py would be something like this:
 
 .. code-block:: python
 
+    from django.shortcuts import render
+
     from myapp.models import Book
 
     def booklist(request):
 
 .. code-block:: python
 
+    from django.shortcuts import render
     from django_easyfilters import FilterSet
+
     from myapp.models import Book
 
     class BookFilterSet(FilterSet):
 to be displayed on the template.
 
 Then, in the template, just add ``{{ booksfilter }}`` to the template.
-books. You can also use pagination e.g. using django-pagination:
+You can also use pagination e.g. using django-pagination:
 
 .. code-block:: django