From 834c03e85aee34abeb60d08ac80a020565734c3a Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Mon, 13 Apr 2015 08:40:50 -0400 Subject: Document that decode_rfc6979_signature raises ValueError --- docs/hazmat/primitives/asymmetric/utils.rst | 3 +++ 1 file changed, 3 insertions(+) (limited to 'docs/hazmat/primitives/asymmetric') diff --git a/docs/hazmat/primitives/asymmetric/utils.rst b/docs/hazmat/primitives/asymmetric/utils.rst index 6b348801..e16c76f1 100644 --- a/docs/hazmat/primitives/asymmetric/utils.rst +++ b/docs/hazmat/primitives/asymmetric/utils.rst @@ -15,6 +15,9 @@ Asymmetric Utilities :returns: The decoded tuple ``(r, s)``. + :raises ValueError: Raised if the signature is malformed in any way. This + **does not** ensure that the signature is *valid*. + .. function:: encode_rfc6979_signature(r, s) Creates an :rfc:`6979` byte string from raw signature values. -- cgit v1.2.3 From 45a7fdb0a7c803dafe6a4deed00c166a8cfa2fc7 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Mon, 13 Apr 2015 08:42:22 -0400 Subject: Removed a confusing sentence --- docs/hazmat/primitives/asymmetric/utils.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'docs/hazmat/primitives/asymmetric') diff --git a/docs/hazmat/primitives/asymmetric/utils.rst b/docs/hazmat/primitives/asymmetric/utils.rst index e16c76f1..f794643c 100644 --- a/docs/hazmat/primitives/asymmetric/utils.rst +++ b/docs/hazmat/primitives/asymmetric/utils.rst @@ -15,8 +15,7 @@ Asymmetric Utilities :returns: The decoded tuple ``(r, s)``. - :raises ValueError: Raised if the signature is malformed in any way. This - **does not** ensure that the signature is *valid*. + :raises ValueError: Raised if the signature is malformed in any way. .. function:: encode_rfc6979_signature(r, s) -- cgit v1.2.3 From 2d72cbfba6a183f98626f7f63a286c57b05e24d0 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Mon, 13 Apr 2015 08:49:18 -0400 Subject: Simpler language --- docs/hazmat/primitives/asymmetric/utils.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/hazmat/primitives/asymmetric') diff --git a/docs/hazmat/primitives/asymmetric/utils.rst b/docs/hazmat/primitives/asymmetric/utils.rst index f794643c..7380f0b5 100644 --- a/docs/hazmat/primitives/asymmetric/utils.rst +++ b/docs/hazmat/primitives/asymmetric/utils.rst @@ -15,7 +15,7 @@ Asymmetric Utilities :returns: The decoded tuple ``(r, s)``. - :raises ValueError: Raised if the signature is malformed in any way. + :raises ValueError: Raised if the signature is malformed. .. function:: encode_rfc6979_signature(r, s) -- cgit v1.2.3