chore(docs): update documentations on leeway#1101
Open
acomarcho wants to merge 5 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates PyJWT documentation to clarify that the leeway parameter applies to all time-based claims, including iat, reducing confusion around clock-skew handling during validation.
Changes:
- Update
decode()/decode_complete()API docstrings to stateleewayapplies toexp,nbf, andiat. - Add usage-guide documentation and an example showing
iatvalidation withleeway.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
jwt/api_jwt.py |
Clarifies leeway semantics in public decode API docstrings (exp/nbf/iat). |
docs/usage.rst |
Adds an iat + leeway explanation and example to the user-facing docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Hi, first of all, thank you for the great library!
I made this PR as I was having some troubles navigating around the documentation. For the context:
iatthat are faster than my server time.leewayproperty, but got confused as in "does this library support it or not?"leewayonly exists fornbfandexp, so I was thinking "oh, then,leewaydoesn't work foriat"_validate_iatactually does! (see appendix A)leewayis only forexpirationwhich might be misleading.See appendix B for the screenshots of the updated documentation.
Apologies for any mistakes if I'm contributing the wrong way (do I need to create an issue first, etc.) - this is my first time contributing to one. This PR was mostly inspired by #1034 which adds documentation for
nbf.Appendix A
Appendix B