diff options
author | Jeremy Lainé <jeremy.laine@m4x.org> | 2019-10-19 01:23:26 +0200 |
---|---|---|
committer | Alex Gaynor <alex.gaynor@gmail.com> | 2019-10-18 19:23:26 -0400 |
commit | b53ecefbf54323b623d2ec4803c48edadfa8d6ca (patch) | |
tree | 57cc6547d7720b595f2397c8b9f2da369c3d8de7 | |
parent | 2620fd85d82308401ab6888ef178496b07263b65 (diff) | |
download | cryptography-b53ecefbf54323b623d2ec4803c48edadfa8d6ca.tar.gz cryptography-b53ecefbf54323b623d2ec4803c48edadfa8d6ca.tar.bz2 cryptography-b53ecefbf54323b623d2ec4803c48edadfa8d6ca.zip |
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.
-rw-r--r-- | docs/hazmat/primitives/key-derivation-functions.rst | 5 |
1 files changed, 2 insertions, 3 deletions
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` |