Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Added documentation for
jwt.decode_complete
.I'm honestly unsure if everything needs to be duplicated or not since the only thing that is different to
jwt.decode
is the return value. I'm happy to just writeParameters: Sames as jwt.decode
if that is preferred.I previously wrote (e.g.)
verify_aud=True`` but will be ignored if ``verify_signature`` is ``False``.
for all the options parameters exceptrequire
andverify_signature
, but that is a bad way of describing it.What I wanted to write was that the value is
True
by default, but will default toFalse
ifverify_signature
is set to false. In other words, they default to the same value asverify_signature
. I, therefore, think that a better way of writing this isverify_aud=verify_signature
, and then moveverify_signature=True
to the top. This way, it is understandable that it is possible to set (e.g.)verify_aud=True
andverify_signature=False
.Added a warning regarding
exp
,iat
andnbf
only being verified if present.Screenshot (Firefox Developers Edition 89.0b5)
![Documentation](https://user-images.githubusercontent.com/47516968/116575019-3d3c4980-a949-11eb-9412-a1d0af50bbc8.png)