Skip to content

fix(core): improve docs on afterRender hooks - #56522

Closed
cexbrayat wants to merge 1 commit into
angular:mainfrom
cexbrayat:fix/after-render-phase-warning-typo
Closed

fix(core): improve docs on afterRender hooks#56522
cexbrayat wants to merge 1 commit into
angular:mainfrom
cexbrayat:fix/after-render-phase-warning-typo

Conversation

@cexbrayat

@cexbrayat cexbrayat commented Jun 19, 2024

Copy link
Copy Markdown
Member

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • angular.io application / infrastructure changes
  • Other... Please describe:

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 named options instead of being called opts in some functions and options in others).

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@cexbrayat
fix(core): improve docs on afterRender hooks
df747cb 
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).
@pullapprove
pullapprove Bot requested a review from devversion June 19, 2024 17:46
@angular-robot angular-robot Bot added the area: core Issues related to the framework runtime label Jun 19, 2024
@ngbot ngbot Bot added this to the Backlog milestone Jun 19, 2024
AndrewKushnir
AndrewKushnir approved these changes Jun 19, 2024
View reviewed changes

@AndrewKushnir AndrewKushnir left a comment

Copy link
Copy Markdown
Contributor

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 👍

AndrewKushnir
AndrewKushnir approved these changes Jun 19, 2024
View reviewed changes

@AndrewKushnir AndrewKushnir left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Reviewed-for: public-api

@pullapprove
pullapprove Bot requested a review from alxhub June 19, 2024 21:12
@AndrewKushnir AndrewKushnir added target: patch This PR is targeted for the next patch release action: presubmit The PR is in need of a google3 presubmit labels Jun 19, 2024
@AndrewKushnir

AndrewKushnir commented Jun 19, 2024

Copy link
Copy Markdown
Contributor

Presubmit.

@AndrewKushnir AndrewKushnir added action: merge The PR is ready for merge by the caretaker merge: caretaker note Alert the caretaker performing the merge to check the PR for an out of normal action needed or note PullApprove: disable and removed action: presubmit The PR is in need of a google3 presubmit labels Jun 20, 2024
@AndrewKushnir

AndrewKushnir commented Jun 20, 2024

Copy link
Copy Markdown
Contributor

Caretaker notes:

  • presubmit is "green"
  • there is no real change to the public API (only argument rename), no need for extra reviews
  • this PR is ready for merge

pkozlowski-opensource
pkozlowski-opensource approved these changes Jun 20, 2024
View reviewed changes

@pkozlowski-opensource pkozlowski-opensource left a comment

Copy link
Copy Markdown
Member

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

@AndrewKushnir AndrewKushnir added target: minor This PR is targeted for the next minor release and removed target: patch This PR is targeted for the next patch release labels Jun 20, 2024
@AndrewKushnir

AndrewKushnir commented Jun 20, 2024

Copy link
Copy Markdown
Contributor

This PR was merged into the repository by commit 86bcfd3.

The changes were merged into the following branches: main

@AndrewKushnir

AndrewKushnir commented Jun 20, 2024

Copy link
Copy Markdown
Contributor

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

@cexbrayat cexbrayat mentioned this pull request Jun 20, 2024
Closed
4 of 13 tasks
@cexbrayat

cexbrayat commented Jun 20, 2024

Copy link
Copy Markdown
Member Author

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

@angular-automatic-lock-bot

angular-automatic-lock-bot Bot commented Jul 21, 2024

Copy link
Copy Markdown

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot Bot locked and limited conversation to collaborators Jul 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@pkozlowski-opensource pkozlowski-opensource pkozlowski-opensource approved these changes
@devversion devversion devversion approved these changes
@AndrewKushnir AndrewKushnir AndrewKushnir approved these changes

Assignees

No one assigned

Labels

action: merge The PR is ready for merge by the caretaker area: core Issues related to the framework runtime merge: caretaker note Alert the caretaker performing the merge to check the PR for an out of normal action needed or note PullApprove: disable target: minor This PR is targeted for the next minor release

Projects

None yet

Milestone

Backlog

Development

Successfully merging this pull request may close these issues.

4 participants

@cexbrayat @AndrewKushnir @pkozlowski-opensource @devversion