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
Made entity listener documentation less ambiguous #910
Conversation
Thank you for the proofreading @greg0ire |
In case #906 gets merged before this PR, a rebase will be needed. |
Updated & commits squashed. @SenseException I hope those 2 PR can get merged soon, the documentation is really opaque right now and I'm sure it is impacting a lot of readers. No problems for rebasing/updating my PR if #906 is merged before, but maybe this PR would supersede it? |
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 the changes @romaricdrigon! Could I ask you to rebase the PR against the 1.10 branch so we can fix the docs for the currently stable version? Thanks!
Sure @alcaeus , here you are :) |
@romaricdrigon I merged #906 not realising that there is a lot more documentation that was missing. Could you please rebase the PR one last time and fix the issue I highlighted above? Other than that, this is good to go. |
Entity listener documentation was giving different syntaxes, without explaining was was required exactly and for which versions to use those. This change clears it up.
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.
Looks good from my end, thanks @romaricdrigon!
I've made some more changes to cleanly wrap at 80 characters and removed some trailing spaces.
The symfony.com documentation (https://symfony.com/doc/master/bundles/DoctrineBundle/entity-listeners.html) was never updated, do you know why? Is it based on another branch (master?)? |
I can take a look at that next week, will be out for a few days for personal reasons. |
Sure, thank you |
I saw the Symfony website was updated, thanks :) |
Hello,
Entity listener documentation was giving different syntaxes, without explaining was was required exactly and for which versions to use those. It was hard to understand the entity annotation is required if you use the "short" service definition, or that you can use the "long" comprehensive service definition in place.
It was misleading for new users, and even for senior ones, I got it wrong today.
This change proposal hopes to make it clearer, but explaining the 2 different syntaxes one after the other.