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

standardize on the term entity attribute #935

Merged

Conversation

njr-11
Copy link
Contributor

@njr-11 njr-11 commented Jan 9, 2025

Fixes #906

Updates existing Javadoc and spec doc to refer to use consistent terminology when referring to entity attributes/fields/properties.

Hopefully this will be easier for our users to understand because we will no longer be switching back and forth between entity attribute / field / property / fields and properties, and so forth everywhere, which gave the appearance of them being different things.

@njr-11 njr-11 added the documentation Improvements or additions to documentation label Jan 9, 2025
@njr-11 njr-11 added this to the 1.1 milestone Jan 9, 2025
* @param <T> entity class of the sortable property.
* @param property the property name to order by
* @param <T> entity class of the sortable entity attribute.
* @param attributeName name of the entity attribute to order by
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

attributeNamesounds odd, why not just attribute?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the feedback. I can switch it to that. Here is the commit for it, d82c044

@otaviojava
Copy link
Contributor

@njr-11 we agreed with attribute why did you put attribute in the parameters?

@otaviojava otaviojava merged commit 87149b9 into jakartaee:main Jan 11, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Can we use more consistent terminology for entity attribute/field/property?
2 participants