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.

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

Color/disabled mixins removed properties from the api docs #5284

Closed
willshowell opened this issue Jun 21, 2017 · 5 comments · Fixed by #9299
Closed

Color/disabled mixins removed properties from the api docs #5284

willshowell opened this issue Jun 21, 2017 · 5 comments · Fixed by #9299
Assignees
Labels
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

@willshowell
Copy link
Contributor

Bug, feature request, or proposal:

Docs bug

What is the expected behavior?

A component that implements CanDisable or CanColor should still show color and disabled as valid properties with descriptions in the component's api reference.

Reproduction

Checkbox implements both, but has no reference: https://material.angular.io/components/checkbox/api

@devversion
Copy link
Member

Yeah this is a known issue. We need to see if we can somehow get a Dgeni processor that properly handles mixins

@jelbourn jelbourn added 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 labels Jun 23, 2017
@jelbourn
Copy link
Member

@devversion we could alternatively try to pull the properties from the interface (e.g. CanDisable)

@willshowell
Copy link
Contributor Author

willshowell commented Oct 4, 2017

@devversion have you had the chance to look into this? Looking at the dgeni-packages CHANGELOG, it looks like there have been some improvements to how implements and extends work, but I'm not familiar enough with Dgeni to know if they're valuable.

EDIT: I see that #6947 upgrades the version. Maybe something to revisit after that lands.

@devversion
Copy link
Member

@willshowell Yeah that's the plan. Just wanted to upgrade everything and revisit this afterwards.

@devversion devversion self-assigned this Jan 5, 2018
devversion added a commit to devversion/material2 that referenced this issue Jan 9, 2018
* Fixes that properties from mixins (e.g color, disabled) are not showing up in the docs.
* No longer runs Dgeni twice when executing the docs task.

Fixes angular#5284
andrewseguin pushed a commit that referenced this issue Jan 12, 2018
* Fixes that properties from mixins (e.g color, disabled) are not showing up in the docs.
* No longer runs Dgeni twice when executing the docs task.

Fixes #5284
andrewseguin pushed a commit that referenced this issue Jan 17, 2018
* Fixes that properties from mixins (e.g color, disabled) are not showing up in the docs.
* No longer runs Dgeni twice when executing the docs task.

Fixes #5284
@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 8, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
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
Development

Successfully merging a pull request may close this issue.

3 participants