diff options
| author | Alex Gaynor <alex.gaynor@gmail.com> | 2013-10-29 15:26:50 -0700 |
|---|---|---|
| committer | Alex Gaynor <alex.gaynor@gmail.com> | 2013-10-29 15:26:50 -0700 |
| commit | 4658ce1c5501d04f11cc91147ac4f8aa884ac26c (patch) | |
| tree | 2c3477f02457a362ed4a9ca100c705449e5f6fbd /docs/hazmat/primitives/hmac.rst | |
| parent | a9d9922f82d4e7b940679c4b548a4b14d0958ed9 (diff) | |
| download | cryptography-4658ce1c5501d04f11cc91147ac4f8aa884ac26c.tar.gz cryptography-4658ce1c5501d04f11cc91147ac4f8aa884ac26c.tar.bz2 cryptography-4658ce1c5501d04f11cc91147ac4f8aa884ac26c.zip | |
Use current module in the hmac docs, for consistency
Diffstat (limited to 'docs/hazmat/primitives/hmac.rst')
| -rw-r--r-- | docs/hazmat/primitives/hmac.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/hazmat/primitives/hmac.rst b/docs/hazmat/primitives/hmac.rst index bfbe3255..e66de36f 100644 --- a/docs/hazmat/primitives/hmac.rst +++ b/docs/hazmat/primitives/hmac.rst @@ -8,6 +8,8 @@ Hash-based Message Authentication Codes ======================================= +.. currentmodule:: cryptography.hazmat.primitives.hmac + .. testsetup:: import binascii @@ -18,7 +20,7 @@ message authentication codes using a cryptographic hash function coupled with a secret key. You can use an HMAC to verify integrity as well as authenticate a message. -.. class:: cryptography.hazmat.primitives.hmac.HMAC(key, msg=None, digestmod=None) +.. class:: HMAC(key, msg=None, digestmod=None) HMAC objects take a ``key``, a hash class derived from :class:`~cryptography.primitives.hashes.BaseHash`, and optional message. |