summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/releases/3.1.txt4
-rw-r--r--docs/topics/auth/passwords.txt16
2 files changed, 14 insertions, 6 deletions
diff --git a/docs/releases/3.1.txt b/docs/releases/3.1.txt
index e4992b0a4a..492622d3bd 100644
--- a/docs/releases/3.1.txt
+++ b/docs/releases/3.1.txt
@@ -603,6 +603,10 @@ Miscellaneous
* The admin CSS classes ``row1`` and ``row2`` are removed in favor of
``:nth-child(odd)`` and ``:nth-child(even)`` pseudo-classes.
+* The :func:`~django.contrib.auth.hashers.make_password` now requires its
+ argument to be a string or bytes. Other types should be explicitly cast to
+ one of these.
+
.. _deprecated-features-3.1:
Features deprecated in 3.1
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)