-
Notifications
You must be signed in to change notification settings - Fork 5.9k
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.
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
Fixes the Javadoc of ClaimAccessor methods for Map/List #10129
Conversation
@shartte Please sign the Contributor License Agreement! Click here to manually synchronize the status of this Pull Request. See the FAQ for frequently asked questions. |
@pivotal-cla This is an Obvious Fix |
@shartte This Pull Request contains an obvious fix. Signing the Contributor License Agreement is not necessary. |
…implementation behavior in case the claims cannot be converted to Map/List.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR, @shartte! I've left some feedback inline.
Also, in preparation for merging will you please squash your commits and format them according to the contributing guidelines?
* @return the claim value or {@code null} if it does not exist or cannot be assigned | ||
* to a {@code Map} | ||
* @return the claim value or {@code null} if it does not exist | ||
* @throws IllegalArgumentException If the claim exists, but cannot be converted to a |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency with the rest of the Javadoc, will you please leave "If" lowercased in both of your changes?
@@ -136,8 +136,9 @@ default URL getClaimAsURL(String claim) { | |||
* Returns the claim value as a {@code Map<String, Object>} or {@code null} if it does |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please update the copyright message to "2021".
I am sorry, but this is turning out to be more busywork than I had anticipated to update two lines of javadoc. |
I can see how for a small change some of these guidelines may seem like a lot to do. I'm sorry if I made it seem like busywork. Holding to these contribution guidelines plays an important role in keeping the code quality high - it was not my intent to give you meaningless work to keep you busy. Thank you for taking the time to contribute, and I hope to see you again down the road. |
Fixes #10117 by correcting the Javadoc to match the implementation behavior.