Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

[1.5.x] Fixed #19588 - Added create_superuser to UserManager docs.

Thanks minddust for the report.

Backport of 4da5947 from master
  • Loading branch information...
commit 72ef63bf86b12e752f186d562d9094cfde30af27 1 parent b4544db
@timgraham timgraham authored
Showing with 11 additions and 11 deletions.
  1. +11 −11 docs/ref/contrib/auth.txt
View
22 docs/ref/contrib/auth.txt
@@ -218,9 +218,10 @@ Manager methods
.. class:: models.UserManager
The :class:`~django.contrib.auth.models.User` model has a custom manager
- that has the following helper methods:
+ that has the following helper methods (in addition to the methods provided
+ by :class:`~django.contrib.auth.models.BaseUserManager`):
- .. method:: create_user(username, email=None, password=None)
+ .. method:: create_user(username, email=None, password=None, **extra_fields)
.. versionchanged:: 1.4
The ``email`` parameter was made optional. The username
@@ -240,18 +241,17 @@ Manager methods
:meth:`~django.contrib.auth.models.User.set_unusable_password()` will
be called.
- See :ref:`Creating users <topics-auth-creating-users>` for example usage.
+ The ``extra_fields`` keyword arguments are passed through to the
+ :class:`~django.contrib.auth.models.User`'s ``__init__`` method to
+ allow setting arbitrary fields on a :ref:`custom User model
+ <auth-custom-user>`.
- .. method:: make_random_password(length=10, allowed_chars='abcdefghjkmnpqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789')
+ See :ref:`Creating users <topics-auth-creating-users>` for example usage.
- Returns a random password with the given length and given string of
- allowed characters. (Note that the default value of ``allowed_chars``
- doesn't contain letters that can cause user confusion, including:
+ .. method:: create_superuser(self, username, email, password, **extra_fields)
- * ``i``, ``l``, ``I``, and ``1`` (lowercase letter i, lowercase
- letter L, uppercase letter i, and the number one)
- * ``o``, ``O``, and ``0`` (uppercase letter o, lowercase letter o,
- and zero)
+ Same as :meth:`create_user`, but sets :attr:`~models.User.is_staff` and
+ :attr:`~models.User.is_superuser` to ``True``.
Anonymous users
Please sign in to comment.
Something went wrong with that request. Please try again.