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.

Sign up for GitHub

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

Jump to bottom

fix(cdk/a11y): FocusTrap deprecation docs don't render correctly #22137

Merged
merged 1 commit into from Mar 19, 2021
Merged

fix(cdk/a11y): FocusTrap deprecation docs don't render correctly #22137

merged 1 commit into from Mar 19, 2021

Conversation

Splaktar
Copy link
Member

@Splaktar Splaktar commented Mar 7, 2021 •
edited

  • fix invalid usage of @breaking-change
  • update breaking change dgeni template to add 'or later'
  • fix a couple of API doc typos

Relates to #18201. Relates to #22136.

Before

Will be deleted in vfor 11.0.0 Remove this class.
Tooltip: "Will be deleted in vfor 11.0.0 Remove this class."

After

Verified via yarn build-docs-content that it generates this output now:

<div class="docs-api-class-deprecated-marker" title="Will be removed in v11.0.0 or later">
  Deprecated
</div>

Questions

While this fixes the tooltip to render properly. It still states that the FocusTrap class will be removed in v11.0.0, but that didn't happen and it may not be removed in v12.0.0 either. Should we update this (to what release?) or leave it as is?

@Splaktar Splaktar added P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent docs This issue is related to documentation area: cdk/a11y labels Mar 7, 2021
@Splaktar Splaktar self-assigned this Mar 7, 2021
@google-cla google-cla bot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Mar 7, 2021
@Splaktar Splaktar added the target: patch This PR is targeted for the next patch release label Mar 7, 2021
@Splaktar Splaktar force-pushed the focus-trap-fix-deprecation-docs branch 2 times, most recently from d43751b to 59969c5 Compare March 11, 2021 17:41
@Splaktar
Copy link
Member Author

Updated based on discussion in team meeting.

@Splaktar Splaktar added the action: merge The PR is ready for merge by the caretaker label Mar 11, 2021
@Splaktar
fix(cdk/a11y): FocusTrap deprecation docs don't render correctly
5f43efd 
- fix invalid usage of `@breaking-change`
- update breaking change dgeni template to add 'or later'
- fix a couple of API doc typos

Relates to angular#18201. Relates to angular#22136.
@Splaktar Splaktar force-pushed the focus-trap-fix-deprecation-docs branch from 59969c5 to 5f43efd Compare March 11, 2021 18:36
@Splaktar Splaktar requested a review from a team as a code owner March 11, 2021 18:36
@Splaktar Splaktar removed the action: merge The PR is ready for merge by the caretaker label Mar 11, 2021
@Splaktar Splaktar requested a review from crisbeto March 11, 2021 18:36
@Splaktar Splaktar added P2 The issue is important to a large percentage of users, with a workaround and removed P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent labels Mar 11, 2021
crisbeto
crisbeto approved these changes Mar 11, 2021
View reviewed changes
Copy link
Member

@crisbeto crisbeto left a comment

Choose a reason for hiding this comment

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

LGTM

@crisbeto crisbeto added the action: merge The PR is ready for merge by the caretaker label Mar 11, 2021
@josephperrott josephperrott requested review from crisbeto and removed request for a team March 11, 2021 18:37
@Splaktar Splaktar assigned mmalerba and unassigned Splaktar Mar 11, 2021
@Splaktar Splaktar assigned andrewseguin and unassigned mmalerba Mar 19, 2021
@andrewseguin andrewseguin merged commit c0286ea into angular:master Mar 19, 2021
andrewseguin pushed a commit that referenced this pull request Mar 19, 2021
@Splaktar @andrewseguin
fix(cdk/a11y): FocusTrap deprecation docs don't render correctly (#22137
032c4e4 
)

- fix invalid usage of `@breaking-change`
- update breaking change dgeni template to add 'or later'
- fix a couple of API doc typos

Relates to #18201. Relates to #22136.

(cherry picked from commit c0286ea)
@Splaktar Splaktar deleted the focus-trap-fix-deprecation-docs branch March 19, 2021 19:06
@angular-automatic-lock-bot
Copy link

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 Apr 19, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@vanessanschmitt vanessanschmitt Awaiting requested review from vanessanschmitt

@devversion devversion Awaiting requested review from devversion

@jelbourn jelbourn Awaiting requested review from jelbourn

@crisbeto crisbeto Awaiting requested review from crisbeto

Assignees

@andrewseguin andrewseguin

Labels
action: merge The PR is ready for merge by the caretaker area: cdk/a11y cla: yes PR author has agreed to Google's Contributor License Agreement docs This issue is related to documentation P2 The issue is important to a large percentage of users, with a workaround target: patch This PR is targeted for the next patch release
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@Splaktar @crisbeto @mmalerba @andrewseguin