diff options
Diffstat (limited to 'docs/topics/auth/passwords.txt')
| -rw-r--r-- | docs/topics/auth/passwords.txt | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/docs/topics/auth/passwords.txt b/docs/topics/auth/passwords.txt index 134ef14583..cc8ca55501 100644 --- a/docs/topics/auth/passwords.txt +++ b/docs/topics/auth/passwords.txt @@ -402,12 +402,16 @@ from the ``User`` model. .. function:: make_password(password, salt=None, hasher='default') Creates a hashed password in the format used by this application. It takes - one mandatory argument: the password in plain-text. Optionally, you can - provide a salt and a hashing algorithm to use, if you don't want to use the - defaults (first entry of ``PASSWORD_HASHERS`` setting). See - :ref:`auth-included-hashers` for the algorithm name of each hasher. If the - password argument is ``None``, an unusable password is returned (one that - will never be accepted by :func:`check_password`). + one mandatory argument: the password in plain-text (string or bytes). + Optionally, you can provide a salt and a hashing algorithm to use, if you + don't want to use the defaults (first entry of ``PASSWORD_HASHERS`` + setting). See :ref:`auth-included-hashers` for the algorithm name of each + hasher. If the password argument is ``None``, an unusable password is + returned (one that will never be accepted by :func:`check_password`). + + .. versionchanged:: 3.1 + + The ``password`` parameter must be a string or bytes if not ``None``. .. function:: is_password_usable(encoded_password) |