Commits

James Bennett  committed 9b1955e

Some more documentation updates to go with the previous change.

  • Participants
  • Parent commits ec5ec67

Comments (0)

Files changed (3)

File docs/default-backend.rst

 overridden by passing the keyword argument ``success_url`` to the
 :func:`~registration.views.register` view.
 
+Upon successful activation, the default redirect is to the URL pattern
+named ``registration_activation_complete``; this can be overridden by
+passing the keyword argument ``success_url`` to the
+:func:`~registration.views.activate` view.
+
 
 How account data is stored for activation
 -----------------------------------------

File docs/quickstart.rst

 
 **registration/activate.html**
 
-Used during account activation. By default, has the following context:
+Used if account activation fails. With the default setup, has the following context:
 
-``account``
-    If activation was successful, the ``User`` object representing the
-    account which was just activated. If activation was unsuccessful,
-    the boolean value ``False``; this may be because the activation
-    period has expired, or the :func:`~registration.views.activate`
-    view was accessed with an invalid or nonexistent activation
-    key. In such cases, an appropriate error message should be
-    displayed.
+``activation_key``
+    The activation key used during the activation attempt.
+
+**registration/activation_complete.html**
+
+Used after successful account activation. This template has no context
+variables of its own, and should simply inform the user that their
+account is now active.
 
 **registration/activation_email_subject.txt**
 

File docs/upgrade.rst

 ``DeprecationWarning`` (which will begin printing warning messages on
 import) and in 1.0 it will be removed entirely.
 
+
 Changes to registration views
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 :ref:`registration backend <backend-api>` to use, and so any URL
 pattern for these views must supply that argument.
 
-The ``profile_callback`` argument of the ``register`` view has been
-removed; the functionality it provided can now be implemented easily
-via a custom backend, or by connecting listeners to :ref:`the signals
-sent during the registration process <signals>`.
+The ``profile_callback`` argument of the
+:func:`~registration.views.register` view has been removed; the
+functionality it provided can now be implemented easily via a custom
+backend, or by connecting listeners to :ref:`the signals sent during
+the registration process <signals>`.
+
+The :func:`~registration.views.activate` view now issues a redirect
+upon successful activation; in :ref:`the default backend
+<default-backend>` this is to the URL pattern named
+``registration_activation_complete``. On unsuccessful activation, the
+``activate()`` view still displays a template, but its context has
+changed: the context will simply consist of any keyword arguments
+captured in the URL and passed to the view.
+
 
 Changes to registration forms
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 custom backend, or by connecting listeners to :ref:`the signals sent
 during the registration process <signals>`.
 
+
 Changes to the :class:`~registration.models.RegistrationProfile` model
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~