James Bennett avatar James Bennett committed fe454e9

Some more documentation updates, bringing it into line with what's actually going on now.

Comments (0)

Files changed (2)

docs/backend-api.rst

 registration; backends can, for example, implement any of the
 following (not an exhaustive list):
 
-* One-step (register, and done) or two-step (register and activate)
+* One-step (register, and done) or multi-step (register and activate)
   signup.
 
 * Invitation-based registration.
 Specifying the backend to use
 -----------------------------
 
-To determine which backend to use, django-registration consults the
-setting ``REGISTRATION_BACKEND``, which should be the full dotted
-Python import path (as a string) of the class to be used as the
-registration backend. For example, the default backend provided is in
-``registration.backends.default``, implemented as a class named
-``DefaultBackend``; thus, it would be enabled in a Django settings
-file like so::
+To determine which backend to use, the views in django-registration
+accept a keyword argument ``backend``; in all cases, this should be a
+string containing the full dotted Python import path to the backend
+class to be used.
 
-    REGISTRATION_BACKEND = "registration.backends.default.DefaultBackend"
+So, for example, to use the default backend, you'd pass
+the string ``'registration.backends.default.DefaultBackend'`` as the
+value of the ``backend`` argument (and the default URLConf included
+with that backend does so).
 
-If no backend is specified, if the specified module is not found or if
-it does not contain a class of the appropriate name,
-django-registration will raise
-``django.core.exceptions.ImproperlyConfigured`` whenever
-user-registration functionality is accessed.
+The specified backend class will then be imported and instantiated (by
+calling its constructor with no arguments), and the resulting instance
+will be used for all backend-specific functionality.
 
-Once the backend class has been imported, an instance will be created
-(by calling its constructor with no arguments) and that instance will
-be used for all backend-specific functionality.
+If the specified backend class cannot be imported, django-registration
+will raise ``django.core.exceptions.ImproperlyConfigured``.
 
 
 Backend API
 After creating the new user account, this method should create or
 obtain an instance of ``django.contrib.auth.models.User`` representing
 that account. It should then send the signal
-``registration.signals.user_registered``, with two arguments:
+``registration.signals.user_registered``, with three arguments:
 
 ``sender``
     The backend class (e.g., ``self.__class__``).
 If the account is successfully activated, this method should create or
 obtain an instance of ``django.contrib.auth.models.User`` representing
 the activated account. It should then send the signal
-``registration.signals.user_activated``, with two arguments:
+``registration.signals.user_activated``, with three arguments:
 
 ``sender``
     The backend class.
     The Django ``HttpRequest`` object in which a new user is
     attempting to register.
 
+
 post_registration_redirect(self, request, user)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

docs/quickstart.rst

 the following context:
 
 ``form``
-    The registration form. This will be an instance of
-    ``django.forms.Form``; consult `Django's forms documentation
+    The registration form. This will be an instance of some subclass
+    of ``django.forms.Form``; consult `Django's forms documentation
     <http://docs.djangoproject.com/en/dev/topics/forms/>`_ for
     information on how to display this in a template.
 
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.