summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorLewis Cowles <lewiscowles@me.com>2016-09-29 15:23:42 +0100
committerTim Graham <timograham@gmail.com>2016-09-30 14:02:26 -0400
commitfb9f3962756ed80ec8ecec8ec2095ee6bca49efd (patch)
treeeff910cb66b63a012f345c2792e342289149cbe7 /docs
parent36c83a0d1edf634e22b34da47211b8ff51e31dbf (diff)
[1.10.x] Fixed #27294 -- Documented UserCreationForm's fields.
Backport of 1d25eb9688f1a245737490dccf8ba54b6c907052 from master
Diffstat (limited to 'docs')
-rw-r--r--docs/topics/auth/default.txt9
1 files changed, 8 insertions, 1 deletions
diff --git a/docs/topics/auth/default.txt b/docs/topics/auth/default.txt
index ca3c5c2a71..72507f6a17 100644
--- a/docs/topics/auth/default.txt
+++ b/docs/topics/auth/default.txt
@@ -1593,7 +1593,14 @@ provides several built-in forms located in :mod:`django.contrib.auth.forms`:
.. class:: UserCreationForm
- A form for creating a new user.
+ A :class:`~django.forms.ModelForm` for creating a new user.
+
+ It has three fields: ``username`` (from the user model), ``password1``,
+ and ``password2``. It verifies that ``password1`` and ``password2`` match,
+ validates the password using
+ :func:`~django.contrib.auth.password_validation.validate_password`, and
+ sets the user's password using
+ :meth:`~django.contrib.auth.models.User.set_password()`.
.. currentmodule:: django.contrib.auth