Commits

Anonymous committed 6c0c5fb

Documentation fix: views.AutoComplete was erroneously called AutoCompleteView.

Comments (0)

Files changed (2)

docs/library/views.rst

 .. module:: autocomplete.views
 
 
-.. class:: AutoCompleteView
+.. class:: AutoComplete
 
-    The AutoCompleteView is called by an Ajax request when the user starts typing
+    The AutoComplete view is called by an Ajax request when the user starts typing
     [#]_ and returns a set of options, matching the user input, for the requested
     choices-set. The output is encoded as JSON (``mimetype='application/json'``) and
     consists of a list of *key-label* pairs::
         # JSON Response:
         [[9, "Strawberry"], [10, "Cherry"], [11, "Apple"]]
 
-    Since the AutoCompleteView is a class you can subclass it to customize its
+    Since the AutoComplete view is a class you can subclass it to customize its
     behaviour. However a simple instance (:obj:`autocomplete.views.autocomplete`)
     is made available, and it's used for the default value of the *view* argument in
     :class:`~autocomplete.widgets.AutoCompleteWidget` and
 
     .. method:: __call__(request, ac_name[, query_param])
         
-        This method makes AutoCompleteView's instances callable and thus usable
+        This method makes AutoComplete's instances callable and thus usable
         as views.
 
         The optional argument *query_param* is the name of the GET parameter
     .. method:: register(id, queryset, fields[, limit[, key[, label[, auth]]]])
         
         This method is used to register a new choices-set with this instance of
-        AutoCompleteView.
+        AutoComplete.
 
         The method accepts as paramter:
 
 
             .. note::
                 
-                AutoCompleteView is only able to work with querysets and not with
+                AutoComplete is only able to work with querysets and not with
                 normal *hardcoded* choices, as widgets.Select does.
 
          *fields*
 
 .. data:: autocomplete
 
-    This is the AutoCompleteView used by default. It's an instance of
-    :class:`~autocomplete.views.AutoCompleteView`. If you want to customize
+    This is the AutoComplete view used by default. It's an instance of
+    :class:`~autocomplete.views.AutoComplete`. If you want to customize
     your AutoComplete view, you should subclass
-    :class:`autocomplete.views.AutoCompleteView`.
+    :class:`autocomplete.views.AutoComplete`.
 
 
 Using the autocomplete view in your URLConf
 -------------------------------------------
 
 Here's an example of how to edit
-your URLConf to use the default AutoCompleteView's instance::
+your URLConf to use the default AutoComplete's instance::
 
     # your project's urls.py
     from django.conf.urls.defaults import *
         url(r'^autocomplete/(\w+)/$', autocomplete),
     )
 
-Customizing the AutoCompleteView
---------------------------------
+Customizing the AutoComplete view
+---------------------------------
 
 The methods that can be overidden
 are ``not_found`` and ``forbidden``. They are called respectively when the requested
 ::
 
     from django.http import HttpResponse
-    from autocomplete.views import AutoCompleteView
+    from autocomplete.views import AutoComplete
 
-    class MyACView(AutoCompleteView):
+    class MyACView(AutoComplete):
 
         def not_found(self, request, ac_name):
             content = "choices-set %s, not found" % (ac_name,)

docs/library/widgets.rst

     Instead of displaying all the choices at once, the
     :class:`AutoCompleteWidget` requires
     the user to start typing some characters and then gathers, using javascript,
-    the choices matching the user input from a remote :class:`~autocomplete.views.AutoCompleteView`.
+    the choices matching the user input from a remote :class:`~autocomplete.views.AutoComplete` view.
     
     Performing smaller queries, instead of a single enormous one to get all the
     choices at once, significantly reduces the load of the database. Moreover
 
     To make an :class:`AutoCompleteWidget` work you need to:
      * serve the javascript that will render the choices to the user;
-     * add an :class:`~autocomplete.views.AutoCompleteView` to your URLConf so
+     * add an :class:`~autocomplete.views.AutoComplete` view to your URLConf so
        the javascript can collect the choices to display;
      * define one or more *choices-sets* for the
-       :class:`~autocomplete.views.AutoCompleteView` to render.
+       :class:`~autocomplete.views.AutoComplete` view to render.
 
     .. note::
         
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.