JavaDoc needs to align with recent changes to method name grammar #684
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
Signed-off-by: Nathan Rauh <[email protected]>
gavinking
reviewed
Apr 10, 2024
gavinking
approved these changes
Apr 10, 2024
Co-authored-by: Gavin King <[email protected]>
|
I think we can merge this one, no? |
otaviojava
approved these changes
Apr 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
The javadoc needs a few updates to align with the recent grammar changes that made
Byoptional and disallowed its use in the absence of any conditions (for example,deleteBy()). Also, it looks like the javadoc doesn't make any mention of the ability to place ignored text in certain parts of the method name. This PR attempts to get the javadoc more lined up with the grammar and the description of it within the specification document. There should be no changes to specification requirements in this PR, only making the javadoc consistent with what the specification already requires.