clarify the parameter order of the locate() function

jakartaee / persistence

https://jakartaee.github.io/persistence/

Other

196 stars 58 forks source link

clarify the parameter order of the locate() function #347

Closed gavinking closed 2 years ago

gavinking commented 2 years ago

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.

I have (a bit laboriously) clarified the semantics of the JPQL function locate(), and added a warning to the Javadoc of CriteriaBuilder.locate().

gavinking commented 2 years ago

update the copyright year in modified files to have 2022, please

OK.

gavinking commented 2 years ago

Done.

lukasj commented 2 years ago

update the copyright year in modified files to have 2022, please

OK.

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

gavinking commented 2 years ago

Perfect, thank you!