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
Improve documentation about naming strategy usage #8041
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your contribution, here are some thoughts on how to make it better :)
docs/en/reference/namingstrategy.rst
Outdated
|
||
|
||
|
||
Warning | ||
|
||
The naming strategy is always overridden by annotations on an entity. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To render a nice warning block we should format this like:
.. warning
The naming strategy is always overridden by annotations on an entity.
I'd also suggest moving this block to the intro (right before the titleConfiguring a naming strategy
) to make things a bit more explicit.
Text-wise I think we could a bit more verbose since I noticed that we do mention this on the intro "when the column or table name is not given".
Perhaps removing the "when the column or table name is not given" and saying something like "Naming strategies are completely ignored when table or column names are provided in the entity mapping", what do you think?
I've moved it up, changed the formatting and removed the part of the intro that implied this but didn't explicitly state it. |
Add a note/warning that annotations override the naming strategy.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you
Add a note/warning that annotations override the naming strategy.