Skip to content

documentation fix: show correct scope for decode_complete() #661

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 10, 2021
Merged

documentation fix: show correct scope for decode_complete() #661

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
documentation fix: show correct scope for decode_complete()
  • Loading branch information
Stefan Seering committed May 21, 2021
commit 83dcb828beb68377fff79e69cd4f1e20084b016c
2 changes: 2 additions & 0 deletions docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,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),
Expand Down