From 4922c45e2dbee7760f17f9776ba39bae0295c1e7 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Thu, 20 Nov 2014 19:45:07 -0800 Subject: fixed a syntax error in the docs --- docs/hazmat/backends/interfaces.rst | 14 +++++++------- docs/hazmat/primitives/asymmetric/ec.rst | 2 +- docs/hazmat/primitives/asymmetric/serialization.rst | 4 ++-- 3 files changed, 10 insertions(+), 10 deletions(-) (limited to 'docs') diff --git a/docs/hazmat/backends/interfaces.rst b/docs/hazmat/backends/interfaces.rst index 78354182..050d69f7 100644 --- a/docs/hazmat/backends/interfaces.rst +++ b/docs/hazmat/backends/interfaces.rst @@ -260,7 +260,7 @@ A specific ``backend`` may provide one or more of these interfaces. :param int key_size: The bit length of the generated modulus. - .. method:: load_rsa_private_numbers(numbers): + .. method:: load_rsa_private_numbers(numbers) :param numbers: An instance of :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPrivateNumbers`. @@ -275,7 +275,7 @@ A specific ``backend`` may provide one or more of these interfaces. :raises cryptography.exceptions.UnsupportedAlgorithm: This raised when any backend specific criteria are not met. - .. method:: load_rsa_public_numbers(numbers): + .. method:: load_rsa_public_numbers(numbers) :param numbers: An instance of :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPrivateNumbers`. @@ -341,7 +341,7 @@ A specific ``backend`` may provide one or more of these interfaces. :raises ValueError: This is raised if the key size is not supported by the backend. - .. method:: dsa_hash_supported(algorithm): + .. method:: dsa_hash_supported(algorithm) :param algorithm: An instance of a :class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm` @@ -350,7 +350,7 @@ A specific ``backend`` may provide one or more of these interfaces. :returns: ``True`` if the specified ``algorithm`` is supported by this backend, otherwise ``False``. - .. method:: dsa_parameters_supported(p, q, g): + .. method:: dsa_parameters_supported(p, q, g) :param int p: The p value of a DSA key. @@ -361,7 +361,7 @@ A specific ``backend`` may provide one or more of these interfaces. :returns: ``True`` if the given values of ``p``, ``q``, and ``g`` are supported by this backend, otherwise ``False``. - .. method:: load_dsa_parameter_numbers(numbers): + .. method:: load_dsa_parameter_numbers(numbers) :param numbers: An instance of :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAParameterNumbers`. @@ -372,7 +372,7 @@ A specific ``backend`` may provide one or more of these interfaces. :raises cryptography.exceptions.UnsupportedAlgorithm: This raised when any backend specific criteria are not met. - .. method:: load_dsa_private_numbers(numbers): + .. method:: load_dsa_private_numbers(numbers) :param numbers: An instance of :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPrivateNumbers`. @@ -383,7 +383,7 @@ A specific ``backend`` may provide one or more of these interfaces. :raises cryptography.exceptions.UnsupportedAlgorithm: This raised when any backend specific criteria are not met. - .. method:: load_dsa_public_numbers(numbers): + .. method:: load_dsa_public_numbers(numbers) :param numbers: An instance of :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicNumbers`. diff --git a/docs/hazmat/primitives/asymmetric/ec.rst b/docs/hazmat/primitives/asymmetric/ec.rst index a229fe41..fd20cbb2 100644 --- a/docs/hazmat/primitives/asymmetric/ec.rst +++ b/docs/hazmat/primitives/asymmetric/ec.rst @@ -6,7 +6,7 @@ Elliptic curve cryptography .. currentmodule:: cryptography.hazmat.primitives.asymmetric.ec -.. function:: generate_private_key(curve, backend): +.. function:: generate_private_key(curve, backend) .. versionadded:: 0.5 diff --git a/docs/hazmat/primitives/asymmetric/serialization.rst b/docs/hazmat/primitives/asymmetric/serialization.rst index b86fab64..b0b37b80 100644 --- a/docs/hazmat/primitives/asymmetric/serialization.rst +++ b/docs/hazmat/primitives/asymmetric/serialization.rst @@ -63,7 +63,7 @@ don't need to worry about this detail. PEM keys are recognizable because they all begin with ``-----BEGIN {format}-----`` and end with ``-----END {format}-----``. -.. function:: load_pem_private_key(data, password, backend): +.. function:: load_pem_private_key(data, password, backend) .. versionadded:: 0.6 @@ -92,7 +92,7 @@ all begin with ``-----BEGIN {format}-----`` and end with ``-----END is not supported by the backend or if the key is encrypted with a symmetric cipher that is not supported by the backend. -.. function:: load_pem_public_key(data, backend): +.. function:: load_pem_public_key(data, backend) .. versionadded:: 0.6 -- cgit v1.2.3