aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2014-05-02 14:47:29 -0700
committerAlex Gaynor <alex.gaynor@gmail.com>2014-05-02 14:47:29 -0700
commit7029a4f409094fd59ea53508368e2dfb026a90b9 (patch)
treeae92dde1f4022206a4eb43df35603a0c9ccc6385
parent06e5bde2815520d16b185578036980f91d9bc2b4 (diff)
parent19e97bd119a417d61c6b844d6e38734d457c779b (diff)
downloadcryptography-7029a4f409094fd59ea53508368e2dfb026a90b9.tar.gz
cryptography-7029a4f409094fd59ea53508368e2dfb026a90b9.tar.bz2
cryptography-7029a4f409094fd59ea53508368e2dfb026a90b9.zip
Merge pull request #1002 from public/doc-tweaks-4
Fix some typos in the docs
-rw-r--r--docs/hazmat/primitives/asymmetric/dsa.rst10
-rw-r--r--docs/hazmat/primitives/mac/cmac.rst6
-rw-r--r--docs/hazmat/primitives/mac/hmac.rst4
-rw-r--r--docs/hazmat/primitives/symmetric-encryption.rst4
4 files changed, 14 insertions, 10 deletions
diff --git a/docs/hazmat/primitives/asymmetric/dsa.rst b/docs/hazmat/primitives/asymmetric/dsa.rst
index f7abaf0f..cc46029c 100644
--- a/docs/hazmat/primitives/asymmetric/dsa.rst
+++ b/docs/hazmat/primitives/asymmetric/dsa.rst
@@ -38,11 +38,11 @@ DSA
Generate a new ``DSAParameters`` instance using ``backend``.
:param int key_size: The length of the modulus in bits. It should be
- either "1024, 2048 or 3072". For keys generated in 2014 this should
- be `at least 2048`_ (See page 41).
- Note that some applications (such as SSH) have not yet gained support
- for larger key sizes specified in FIPS 186-3 and are still restricted
- to only the 1024-bit keys specified in FIPS 186-2.
+ either 1024, 2048 or 3072. For keys generated in 2014 this should
+ be `at least 2048`_ (See page 41). Note that some applications
+ (such as SSH) have not yet gained support for larger key sizes
+ specified in FIPS 186-3 and are still restricted to only the
+ 1024-bit keys specified in FIPS 186-2.
:return: A new instance of ``DSAParameters``
diff --git a/docs/hazmat/primitives/mac/cmac.rst b/docs/hazmat/primitives/mac/cmac.rst
index a6b048b5..1fde1398 100644
--- a/docs/hazmat/primitives/mac/cmac.rst
+++ b/docs/hazmat/primitives/mac/cmac.rst
@@ -38,9 +38,9 @@ A subset of CMAC with the AES-128 algorithm is described in :rfc:`4493`.
:class:`~cryptography.exceptions.UnsupportedAlgorithm` exception will be
raised.
- If the `algorithm`` isn't a
- :class:`~cryptography.primitives.interfaces.BlockCipherAlgorithm` provider,
- ``TypeError`` will be raised.
+ If ``algorithm`` isn't a
+ :class:`~cryptography.hazmat.primitives.interfaces.BlockCipherAlgorithm`
+ provider then ``TypeError`` will be raised.
To check that a given signature is correct use the :meth:`verify` method.
You will receive an exception if the signature is wrong:
diff --git a/docs/hazmat/primitives/mac/hmac.rst b/docs/hazmat/primitives/mac/hmac.rst
index 11b10735..e20a4034 100644
--- a/docs/hazmat/primitives/mac/hmac.rst
+++ b/docs/hazmat/primitives/mac/hmac.rst
@@ -38,6 +38,10 @@ of a message.
:class:`~cryptography.exceptions.UnsupportedAlgorithm` exception will be
raised.
+ If ``algorithm`` isn't a
+ :class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm` provider
+ then ``TypeError`` will be raised.
+
To check that a given signature is correct use the :meth:`verify` method.
You will receive an exception if the signature is wrong:
diff --git a/docs/hazmat/primitives/symmetric-encryption.rst b/docs/hazmat/primitives/symmetric-encryption.rst
index c98b3814..78bf6637 100644
--- a/docs/hazmat/primitives/symmetric-encryption.rst
+++ b/docs/hazmat/primitives/symmetric-encryption.rst
@@ -134,8 +134,8 @@ Algorithms
.. versionadded:: 0.4
- SEED is a block cipher developed by the Korea Information Security Agency (
- KISA). It is defined in :rfc:`4269` and is used broadly throughout South
+ SEED is a block cipher developed by the Korea Information Security Agency
+ (KISA). It is defined in :rfc:`4269` and is used broadly throughout South
Korean industry, but rarely found elsewhere.
:param bytes key: The secret key. This must be kept secret. ``128`` bits in