clarify the parameter order of the locate() function #347
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
lukasj
reviewed
Jan 18, 2022
| @@ -1170,6 +1170,8 @@ | |||
| * if found. | |||
| * The first position in a string is denoted by 1. If the | |||
| * string to be located is not found, 0 is returned. | |||
| * <p>Warning: the order of the parameters of this method is | |||
There was a problem hiding this comment.
should the word Warning be bold/strong?
There was a problem hiding this comment.
Sure, if you like.
lukasj
reviewed
Jan 18, 2022
OK. |
|
Done. |
it needs to follow https://www.eclipse.org/projects/handbook/#ip-copyright-headers : The date may optionally be set to a range of years with the first and last years of the range separated by a comma (e.g. “2004, 2017”); in this case, the first year is when the content was first created and the last year is when the content was last modified. I know how annoying is keeping this up-to-date... |
The current wording is very difficult for non-native speakers to understand, "located" being almost a synonym for "searched", and was apparently even misread by the person who wrote CriteriaBuilder, since CriteriaBuilder.locate() gets the parameters in the "wrong" order.
|
Perfect, thank you! |
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.
The current wording is very difficult for non-native speakers to understand, "located" being almost a synonym for "searched", and was apparently even misread by the person who wrote
CriteriaBuilder, sinceCriteriaBuilder.locate()gets the parameters in the "wrong" order.I have (a bit laboriously) clarified the semantics of the JPQL function
locate(), and added a warning to the Javadoc ofCriteriaBuilder.locate().