diff options
| author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-01-02 13:34:07 -0800 |
|---|---|---|
| committer | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-01-02 13:34:07 -0800 |
| commit | adbea0d9456dd9261ef59c3c0f2e3466a3937686 (patch) | |
| tree | b2cdc0e15cbf9eafbcd8b87d0b0821165d1de926 /docs | |
| parent | c39559c6d629d68674d240d6e6bcdf44a15d90cf (diff) | |
| parent | 1225270be8af862a82e45342f086419dbedce0fb (diff) | |
| download | cryptography-adbea0d9456dd9261ef59c3c0f2e3466a3937686.tar.gz cryptography-adbea0d9456dd9261ef59c3c0f2e3466a3937686.tar.bz2 cryptography-adbea0d9456dd9261ef59c3c0f2e3466a3937686.zip | |
Merge pull request #391 from alex/spelling-fixes
Correct spelling, fix phrasing, line wrap.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/hazmat/bindings/index.rst | 2 | ||||
| -rw-r--r-- | docs/hazmat/primitives/hmac.rst | 9 |
2 files changed, 7 insertions, 4 deletions
diff --git a/docs/hazmat/bindings/index.rst b/docs/hazmat/bindings/index.rst index 809eddfc..e2a17591 100644 --- a/docs/hazmat/bindings/index.rst +++ b/docs/hazmat/bindings/index.rst @@ -6,7 +6,7 @@ Bindings .. currentmodule:: cryptography.hazmat.bindings ``cryptography`` aims to provide low-level CFFI based bindings to multiple -native C libraries. These provide no automatic initialisation of the library +native C libraries. These provide no automatic initialization of the library and may not provide complete wrappers for its API. Using these functions directly is likely to require you to be careful in diff --git a/docs/hazmat/primitives/hmac.rst b/docs/hazmat/primitives/hmac.rst index b8f94fd2..dc5c54f8 100644 --- a/docs/hazmat/primitives/hmac.rst +++ b/docs/hazmat/primitives/hmac.rst @@ -74,8 +74,11 @@ message. .. method:: verify(signature) - Finalize the current context and securely compare digest to ``signature``. + Finalize the current context and securely compare digest to + ``signature``. - :param bytes signature: The bytes of the HMAC signature recieved. + :param bytes signature: The bytes to compare the current digest + against. :raises cryptography.exceptions.AlreadyFinalized: See :meth:`finalize` - :raises cryptography.exceptions.InvalidSignature: If signature does not match digest + :raises cryptography.exceptions.InvalidSignature: If signature does not + match digest |