From b53ecefbf54323b623d2ec4803c48edadfa8d6ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jeremy=20Lain=C3=A9?= Date: Sat, 19 Oct 2019 01:23:26 +0200 Subject: Move `backend` argument in Scrypt documentation (#5027) Move the `backend` argument up with the rest of the constructor arguments, otherwise it's easy to miss it. --- docs/hazmat/primitives/key-derivation-functions.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/hazmat/primitives/key-derivation-functions.rst b/docs/hazmat/primitives/key-derivation-functions.rst index fe9f0b0d..40a0c3db 100644 --- a/docs/hazmat/primitives/key-derivation-functions.rst +++ b/docs/hazmat/primitives/key-derivation-functions.rst @@ -789,6 +789,8 @@ Different KDFs are suitable for different tasks such as: power of 2. :param int r: Block size parameter. :param int p: Parallelization parameter. + :param backend: An instance of + :class:`~cryptography.hazmat.backends.interfaces.ScryptBackend`. The computational and memory cost of Scrypt can be adjusted by manipulating the 3 parameters: ``n``, ``r``, and ``p``. In general, the memory cost of @@ -802,9 +804,6 @@ Different KDFs are suitable for different tasks such as: minimum value of ``n=2**14`` for interactive logins (t < 100ms), or ``n=2**20`` for more sensitive files (t < 5s). - :param backend: An instance of - :class:`~cryptography.hazmat.backends.interfaces.ScryptBackend`. - :raises cryptography.exceptions.UnsupportedAlgorithm: This is raised if the provided ``backend`` does not implement :class:`~cryptography.hazmat.backends.interfaces.ScryptBackend` -- cgit v1.2.3