Improve documentation for audience usage #484
Merged
Conversation
This file contains 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
The previous code example only showed the `aud` claim as a single case-sensitive string, despite the documentation mentioning that the `aud` claim can be an array of case-sensitive strings Add a code block demonstrating the `aud` claim being an array of case-sensitive strings to make it more clear to the user that it is a permitted use of the `aud` claim
Demonstrate to users reading the documentation that the `audience` parameter is not restricted to the `string` type, but can also accept an iterable, as implemented in PR#306 jpadilla#306
Short title underlines throw warnings in reStructuredText linters
|
this is great, thanks! |
jpadilla
pushed a commit
that referenced
this pull request
Jun 19, 2020
* Add code example for `aud` being an array The previous code example only showed the `aud` claim as a single case-sensitive string, despite the documentation mentioning that the `aud` claim can be an array of case-sensitive strings Add a code block demonstrating the `aud` claim being an array of case-sensitive strings to make it more clear to the user that it is a permitted use of the `aud` claim * Add example of the `audience` param as an iterable Demonstrate to users reading the documentation that the `audience` parameter is not restricted to the `string` type, but can also accept an iterable, as implemented in PR#306 #306 * Fix short title underlines Short title underlines throw warnings in reStructuredText linters
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.
Hello
pyjwtmaintainers,I've recently been using the
pyjwtcodebase to decode JWT tokens originating from Keycloak servers, where the JWTaudclaim is an array by default, and I'm dealing with apythonAPIserver that supports multipleaudiences.The edits I've made in this PR hope to improve the documentation for users who are not as familiar with the specific details surrounding the
audienceclaim, like I was until I started digging into usingpyjwtmore.ddc1dc1
Makes an explicit code block example for the
audclaim being anarray. It was mentioned in the text, but I think making a code block demonstrating it helps make it more clear.46d1940
Adds an example of the
audienceparam forjwt.decodesupporting an iterable argument, as implemented in #306.Note that I'm not stuck to the placement of this example, but I was unsuccessful at locating documentation specific to the
jwt.decodeimplementationf01df86
Is a simple
.rstformatting change where the linter I was using was throwing a warning: