Skip to content
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

Closed
wants to merge 1 commit into from

Conversation

shartte
Copy link

@shartte shartte commented Jul 20, 2021

Fixes #10117 by correcting the Javadoc to match the implementation behavior.

@pivotal-cla
Copy link

@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.

@shartte
Copy link
Author

shartte commented Jul 20, 2021

@pivotal-cla This is an Obvious Fix

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Jul 20, 2021
@pivotal-cla
Copy link

@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.
Copy link
Contributor

@jzheaux jzheaux left a 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
Copy link
Contributor

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
Copy link
Contributor

@jzheaux jzheaux Jul 23, 2021

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".

@shartte
Copy link
Author

shartte commented Jul 24, 2021

I am sorry, but this is turning out to be more busywork than I had anticipated to update two lines of javadoc.
I'll leave this for someone else.

@shartte shartte closed this Jul 24, 2021
@shartte shartte deleted the fix-10117 branch July 24, 2021 15:00
@jzheaux
Copy link
Contributor

jzheaux commented Jul 27, 2021

I am sorry, but this is turning out to be more busywork than I had anticipated

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: waiting-for-triage An issue we've not yet triaged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ClaimAccessor#getClaimAsMap doesn't return null as documented
4 participants