From 87494d19398334c328f0a0c9bd750f66c14da8e1 Mon Sep 17 00:00:00 2001 From: Benjamin Peterson Date: Mon, 12 Oct 2015 20:46:09 -0700 Subject: Indicate the return type of CertificateBuilder.sign --- docs/x509/reference.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs/x509/reference.rst') diff --git a/docs/x509/reference.rst b/docs/x509/reference.rst index 87383db1..c8c58efb 100644 --- a/docs/x509/reference.rst +++ b/docs/x509/reference.rst @@ -503,6 +503,8 @@ X.509 Certificate Builder handled by whoever reads the certificate. .. method:: sign(private_key, algorithm, backend) + + :type: :class:`~cryptography.x509.Certificate` Sign the certificate using the CA's private key. -- cgit v1.2.3 From 9ed312baba7f4024d207a5fc56c3050b8d55b227 Mon Sep 17 00:00:00 2001 From: Benjamin Peterson Date: Mon, 12 Oct 2015 20:51:34 -0700 Subject: use :returns: and put annotation in the correct place --- docs/x509/reference.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/x509/reference.rst') diff --git a/docs/x509/reference.rst b/docs/x509/reference.rst index c8c58efb..15078e9d 100644 --- a/docs/x509/reference.rst +++ b/docs/x509/reference.rst @@ -503,8 +503,6 @@ X.509 Certificate Builder handled by whoever reads the certificate. .. method:: sign(private_key, algorithm, backend) - - :type: :class:`~cryptography.x509.Certificate` Sign the certificate using the CA's private key. @@ -522,6 +520,8 @@ X.509 Certificate Builder Must support the :class:`~cryptography.hazmat.backends.interfaces.X509Backend` interface. + + :returns: :class:`~cryptography.x509.Certificate` X.509 CSR (Certificate Signing Request) Object -- cgit v1.2.3 From 4c2561afecdbd25226f093698404facb8b49abee Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Mon, 12 Oct 2015 23:53:39 -0400 Subject: Use the right reST syntax for these --- docs/x509/reference.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'docs/x509/reference.rst') diff --git a/docs/x509/reference.rst b/docs/x509/reference.rst index 87383db1..25e3e5db 100644 --- a/docs/x509/reference.rst +++ b/docs/x509/reference.rst @@ -226,13 +226,13 @@ X.509 Certificate Object .. method:: public_key() - :type: + The public key associated with the certificate. + + :returns: :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKey` or :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey` or :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey` - The public key associated with the certificate. - .. doctest:: >>> from cryptography.hazmat.primitives.asymmetric import rsa @@ -531,13 +531,13 @@ X.509 CSR (Certificate Signing Request) Object .. method:: public_key() - :type: + The public key associated with the request. + + :returns: :class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKey` or :class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey` or :class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey` - The public key associated with the request. - .. doctest:: >>> from cryptography.hazmat.primitives.asymmetric import rsa -- cgit v1.2.3 From 7f1aa4e9d4a766a7354d3e8f488bca0ec9f8e9da Mon Sep 17 00:00:00 2001 From: Benjamin Peterson Date: Mon, 12 Oct 2015 20:59:07 -0700 Subject: nuke trailing whitespace --- docs/x509/reference.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/x509/reference.rst') diff --git a/docs/x509/reference.rst b/docs/x509/reference.rst index 15078e9d..72603f42 100644 --- a/docs/x509/reference.rst +++ b/docs/x509/reference.rst @@ -520,7 +520,7 @@ X.509 Certificate Builder Must support the :class:`~cryptography.hazmat.backends.interfaces.X509Backend` interface. - + :returns: :class:`~cryptography.x509.Certificate` -- cgit v1.2.3