Improve jwt.decode key doc #198
Merged
Conversation
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
|
Perhaps we should add some tests here? |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #198 +/- ##
=======================================
Coverage 93.51% 93.51%
=======================================
Files 16 16
Lines 1728 1728
=======================================
Hits 1616 1616
Misses 112 112 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Pull Request Overview
This PR improves the documentation for the jwt.decode function’s key parameter by providing more detailed examples of accepted key formats.
- Updated the accepted types for the key parameter from "str or dict" to "str or iterable"
- Expanded the documentation to list multiple acceptable key formats including tuples, lists, JSON strings, and JWK sets
| individual JWK or JWK set. | ||
| key (str or iterable): A key to attempt to verify the payload with. | ||
| This can be simple string with an individual key (e.g. "a1234"), | ||
| a tuple or list of keys (e.g. ("a1234...", "b3579"), |
There was a problem hiding this comment.
The tuple example appears to be missing a closing parenthesis. Consider ensuring that all examples have matching opening and closing parentheses for clarity.
Copilot uses AI. Check for mistakes.
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.
PR for #96