diff options
| author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-11-23 14:59:25 -1000 |
|---|---|---|
| committer | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-11-23 14:59:25 -1000 |
| commit | e987b81aefb7a6545ff23dee8468d0a234cd13f8 (patch) | |
| tree | 3e865ec23b94aeb73aa457a451377d35a0fddb17 /docs/hazmat | |
| parent | a26f9553e435193c07705477def60253f8bc6644 (diff) | |
| parent | 1cfc5d51322678a1fe3120116379de134b7d596c (diff) | |
| download | cryptography-e987b81aefb7a6545ff23dee8468d0a234cd13f8.tar.gz cryptography-e987b81aefb7a6545ff23dee8468d0a234cd13f8.tar.bz2 cryptography-e987b81aefb7a6545ff23dee8468d0a234cd13f8.zip | |
Merge pull request #1487 from alex/more-docs-fixes
A few more docs fixes
Diffstat (limited to 'docs/hazmat')
| -rw-r--r-- | docs/hazmat/backends/interfaces.rst | 3 | ||||
| -rw-r--r-- | docs/hazmat/primitives/key-derivation-functions.rst | 8 |
2 files changed, 5 insertions, 6 deletions
diff --git a/docs/hazmat/backends/interfaces.rst b/docs/hazmat/backends/interfaces.rst index 050d69f7..ce2f0918 100644 --- a/docs/hazmat/backends/interfaces.rst +++ b/docs/hazmat/backends/interfaces.rst @@ -197,8 +197,7 @@ A specific ``backend`` may provide one or more of these interfaces. :returns: ``True`` if the specified ``algorithm`` is supported for PBKDF2 HMAC by this backend, otherwise ``False``. - .. method:: derive_pbkdf2_hmac(self, algorithm, length, salt, iterations, - key_material) + .. method:: derive_pbkdf2_hmac(self, algorithm, length, salt, iterations, key_material) :param algorithm: An instance of a :class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm` diff --git a/docs/hazmat/primitives/key-derivation-functions.rst b/docs/hazmat/primitives/key-derivation-functions.rst index f68b12c1..60096870 100644 --- a/docs/hazmat/primitives/key-derivation-functions.rst +++ b/docs/hazmat/primitives/key-derivation-functions.rst @@ -211,9 +211,9 @@ Different KDFs are suitable for different tasks such as: .. method:: verify(key_material, expected_key) - :param key_material bytes: The input key material. This is the same as + :param bytes key_material: The input key material. This is the same as ``key_material`` in :meth:`derive`. - :param expected_key bytes: The expected result of deriving a new key, + :param bytes expected_key: The expected result of deriving a new key, this is the same as the return value of :meth:`derive`. :raises cryptography.exceptions.InvalidKey: This is raised when the @@ -304,9 +304,9 @@ Different KDFs are suitable for different tasks such as: .. method:: verify(key_material, expected_key) - :param key_material bytes: The input key material. This is the same as + :param bytes key_material: The input key material. This is the same as ``key_material`` in :meth:`derive`. - :param expected_key bytes: The expected result of deriving a new key, + :param bytes expected_key: The expected result of deriving a new key, this is the same as the return value of :meth:`derive`. :raises cryptography.exceptions.InvalidKey: This is raised when the |