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

docs-bug(icon): MatIcon appears in the Directives section #24093

Open
dev054 opened this issue Dec 12, 2021 · 3 comments
Open

docs-bug(icon): MatIcon appears in the Directives section #24093

dev054 opened this issue Dec 12, 2021 · 3 comments
Labels
area: dgeni Issue related to API docs extraction area: material.angular.io docs This issue is related to documentation P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent

Comments

@dev054
Copy link

dev054 commented Dec 12, 2021

Documentation Feedback

Currently the MatIcon appears in the Directives section, however it's a Component:

MatIcon in Directives

Affected documentation page

https://material.angular.io/components/icon/api
@dev054 dev054 added docs This issue is related to documentation needs triage This issue needs to be triaged by the team labels Dec 12, 2021
@dev054
Copy link
Author

dev054 commented Dec 12, 2021

Oh, I just noticed it's happening on all pages, not just for the MatIcon, so now I'm starting to wonder if this is on purpose 🤔

@dev054 dev054 changed the title docs-bug(icon): MatIcons appears as Directive docs-bug(icon): MatIcon appears in the Directives section Dec 12, 2021
@crisbeto
Copy link
Member

It's a bit of trivia from the Angular.js days, but every component is also a directive.

@dev054
Copy link
Author

dev054 commented Dec 16, 2021 •
edited

Yes, I'm aware that a component is, under the hood, a directive, but shouldn't the Material docs differentiate them, like the Angular docs?

@crisbeto crisbeto added area: dgeni Issue related to API docs extraction area: material.angular.io P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent and removed needs triage This issue needs to be triaged by the team labels Dec 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area: dgeni Issue related to API docs extraction area: material.angular.io docs This issue is related to documentation P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@crisbeto @dev054