-
Notifications
You must be signed in to change notification settings - Fork 24.9k
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
fix(core): improve docs on afterRender hooks #56522
fix(core): improve docs on afterRender hooks #56522
Conversation
This commit fixes a typo in the `AfterRenderPhase` deprecation warning and improves the documentation of the options parameter of the afterRender hooks (which are now all named `options` instead of being called `opts` in some functions and `options` in others).
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.
@cexbrayat thanks for the improvement 👍
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.
Reviewed-for: public-api
Caretaker notes:
|
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.
LGTM
Reviewed-for: public-api
Reviewed-for: fw-core
This PR was merged into the repository by commit 86bcfd3. The changes were merged into the following branches: main |
@cexbrayat there was a merge conflict with the 18.0.x branch, so this PR was merged into the main branch only. Could you please create a new PR and target the 18.0.x branch when you get a chance? Thank you. |
@AndrewKushnir Here it is #56525 As the main part of the PR is based on changes introduced in the next release, the new PR is really small (and maybe not worth it). |
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
The AfterPhaseRender deprecation warning has a typo.
What is the new behavior?
This commit fixes a typo in the
AfterRenderPhase
deprecation warning and improves the documentation of the options parameter of the afterRender hooks (which are now all namedoptions
instead of being calledopts
in some functions andoptions
in others).Does this PR introduce a breaking change?
Other information