Skip to content

docs(expansion-panel): fix duplicate selectors and add missing docume… #20286

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

Merged
merged 1 commit into from
Aug 20, 2020

Conversation

rafaelss95
Copy link
Contributor

…ntation

Current behavior:

  • Selectors are written inside JSDoc unnecessarily as the generated docs pick it through the selector attribute, e.g.:
    Captura de Tela 2020-08-12 às 19 58 50
    Note that it results in duplicate selectors in documentation.
  • MatExpansionPanelActionRow has no docs;

PS: About the changed docs feel free to suggest a more readable description.

@rafaelss95 rafaelss95 requested a review from jelbourn as a code owner August 12, 2020 23:04
@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Aug 12, 2020
* `<mat-expansion-panel-header>`
*
* This component corresponds to the header element of an `<mat-expansion-panel>`.
* This corresponds to the header element of a `<mat-expansion-panel>`.
Copy link
Member

Choose a reason for hiding this comment

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

Maybe drop the "This corresponds to the" from all the descriptions? E.g. "Header element of a <mat-expansion-panel>.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@crisbeto Sorry for delay. I changed all descriptions as per your suggestion. Would you take a look?

@rafaelss95 rafaelss95 force-pushed the docs/expansion-panel branch from 5dcec9c to 645281a Compare August 19, 2020 01:47
@rafaelss95 rafaelss95 requested a review from crisbeto August 19, 2020 01:50
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 docs This issue is related to documentation action: merge The PR is ready for merge by the caretaker merge safe target: patch This PR is targeted for the next patch release labels Aug 19, 2020
@wagnermaciel wagnermaciel merged commit f64b60d into angular:master Aug 20, 2020
wagnermaciel pushed a commit that referenced this pull request Aug 20, 2020
@rafaelss95 rafaelss95 deleted the docs/expansion-panel branch August 20, 2020 19:00
@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 Sep 20, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker cla: yes PR author has agreed to Google's Contributor License Agreement docs This issue is related to documentation target: patch This PR is targeted for the next patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants