Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Fixed #19402 - Clarified purpose of CustomUser.REQUIRED_FIELDS

Thanks pydanny for the report and ptone for the patch.
  • Loading branch information...
commit 24a2bcbcdd9e76901cd8f8bb38d9d5b6e0bc4fd6 1 parent 2cd0eda
@timgraham timgraham authored
Showing with 10 additions and 3 deletions.
  1. +10 −3 docs/topics/auth/customizing.txt
View
13 docs/topics/auth/customizing.txt
@@ -507,9 +507,16 @@ 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. For example, here is the partial definition for a User model
- that defines two required fields - a date of birth and height::
+ 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.
+
+ For example, here is the partial definition for a ``User`` model that
+ defines two required fields - a date of birth and height::
class MyUser(AbstractBaseUser):
...
Please sign in to comment.
Something went wrong with that request. Please try again.