summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsseering <git-public@stefan.seeri.ng>2021-12-10 10:22:37 +0100
committerGitHub <noreply@github.com>2021-12-10 15:22:37 +0600
commita3e2d8eb658fbd7677bacfe40189956d47b94ef2 (patch)
treefec79be60852ca3589c44f8d9015a71ff0241a31
parentf3b95a08c7a76cf62b37a3c0baa73bc7f5eac9ac (diff)
downloadpyjwt-a3e2d8eb658fbd7677bacfe40189956d47b94ef2.tar.gz
documentation fix: show correct scope for decode_complete() (#661)
Co-authored-by: Stefan Seering <sseering@todo.find.proper.mail.domain>
-rw-r--r--docs/api.rst2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst
index f1720b9..2f81b1f 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -68,6 +68,8 @@ API Reference
:rtype: dict
:returns: the JWT claims
+.. module:: jwt.api_jwt
+
.. function:: decode_complete(jwt, key="", algorithms=None, options=None, audience=None, issuer=None, leeway=0)
Identical to ``jwt.decode`` except for return value which is a dictionary containing the token header (JOSE Header),