Commit 24a2bcbc authored by Tim Graham's avatar Tim Graham
Browse files

Fixed #19402 - Clarified purpose of CustomUser.REQUIRED_FIELDS

Thanks pydanny for the report and ptone for the patch.
parent 2cd0edaa
Loading
Loading
Loading
Loading
+10 −3
Original line number Diff line number Diff line
@@ -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):
                ...