From 00ab427bd526753b55ad52613be042a59cda00f8 Mon Sep 17 00:00:00 2001 From: Andrey Kislyuk Date: Sun, 27 Nov 2022 15:38:07 -0800 Subject: [PATCH] Clarify docstring --- signxml/verifier.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/signxml/verifier.py b/signxml/verifier.py index f5c4ef8..e2b5796 100644 --- a/signxml/verifier.py +++ b/signxml/verifier.py @@ -86,7 +86,7 @@ class SignatureConfiguration: @dataclass(frozen=True) class VerifyResult: """ - This is a dataclass representing structured data returned by ``signxml.XMLVerifier.verify()``. The results of a + This is a dataclass representing structured data returned by :func:`signxml.XMLVerifier.verify`. The results of a verification contain the signed bytes, the parsed signed XML, and the parsed signature XML. Example usage: verified_data = signxml.XMLVerifier().verify(input_data).signed_xml @@ -239,7 +239,7 @@ def verify( Verify the XML signature supplied in the data and return a list of :class:`VerifyResult` data structures representing the data signed by the signature, or raise an exception if the signature is not valid. By default, this requires the signature to be generated using a valid X.509 certificate. To enable other means of signature - validation, set the **require_x509** argument to `False`. + validation, set ``expect_config`` to a configuration with the **require_x509** parameter set to `False`. .. admonition:: See what is signed