summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2013-09-06 16:01:29 -0400
committerTim Graham <timograham@gmail.com>2013-09-06 16:06:51 -0400
commit5d029f2222e74b3bae2dc6b446214014b708917b (patch)
treed7bfc56c5a93e92888da102127c4ea754368cef2 /docs
parente62f3910226f996278e15e401974c87566ed6fd8 (diff)
[1.5.x] Fixed #20646 -- Clarified the use of AbstractBaseUser.REQUIRED_FIELDS
Thanks craigbruce. Backport of db3de52807 from master
Diffstat (limited to 'docs')
-rw-r--r--docs/topics/auth/customizing.txt16
1 files changed, 9 insertions, 7 deletions
diff --git a/docs/topics/auth/customizing.txt b/docs/topics/auth/customizing.txt
index 61cbb1196a..73a4d5399f 100644
--- a/docs/topics/auth/customizing.txt
+++ b/docs/topics/auth/customizing.txt
@@ -502,13 +502,15 @@ password resets. You must then provide some key implementation details:
.. attribute:: REQUIRED_FIELDS
- A list of the field names that *must* be provided when creating a user
- via the :djadmin:`createsuperuser` management command. The user will be
- prompted to supply a value for each of these fields. It should include
- any field for which :attr:`~django.db.models.Field.blank` is ``False``
- or undefined, but may include additional fields you want prompted for
- when a user is created interactively. However, it will not work for
- :class:`~django.db.models.ForeignKey` fields.
+ A list of the field names that will be prompted for when creating a
+ user via the :djadmin:`createsuperuser` management command. The user
+ will be prompted to supply a value for each of these fields. It must
+ include any field for which :attr:`~django.db.models.Field.blank` is
+ ``False`` or undefined and may include additional fields you want
+ prompted for when a user is created interactively. However, it will not
+ work for :class:`~django.db.models.ForeignKey` fields.
+ ``REQUIRED_FIELDS`` has no effect in other parts of Django, like
+ creating a user in the admin.
For example, here is the partial definition for a ``User`` model that
defines two required fields - a date of birth and height::