chore(docs): show extends clauses for classes #8078
Conversation
googlebot
added
the
cla: yes
| <p class="docs-api-class-extends-clauses"> | ||
| <span class="docs-api-class-extends-label">Extends:</span> | ||
| {% for extendedDoc in class.extendedDocs %} | ||
| <span class="docs-api-class-extends-type">{$ extendedDoc.name $}</span> |
There was a problem hiding this comment.
I think it would be better to show this immediately after the name, e.g.
MatVerticalStepper extends MatStepper
There was a problem hiding this comment.
I tried that and it didn't look that well in my opinion.
But maybe there will be some advanced styling to make this look better. Let me know if we should go that way?
| // a document are unknown and should not be mentioned in the documentation for this class. | ||
| classDoc.extendedDocs = classDoc.extendsClauses | ||
| .filter(clause => clause.doc) | ||
| .map(clause => clause.doc!); |
There was a problem hiding this comment.
Did you confirm that this filters out mixin classes like MatButtonBase?
There was a problem hiding this comment.
Yeah, those are filtered out because there is no Dgeni doc for those.
|
I think a little css would make it look good |
|
@jelbourn Updated the PR and addressed the feedback. |
devversion
force-pushed
the
chore/docs-show-extends-clauses
branch
2 times, most recently
from
5a5ba2d to
d8b3634
Compare
|
There's a lint error: you can add merge-ready when ready |
|
Seems unrelated. But can fix in the PR as well |
Classes like `MatAnchor` in the button docs should indicate that those are extending the `MatButton` class. Clauses without any related Dgeni doc can be ignored, because no information for this is available (right now; e.g. `MatSlideToggleBase` with mixins)
devversion
force-pushed
the
chore/docs-show-extends-clauses
branch
from
d8b3634 to
424207c
Compare
|
Lint issue will be fixed by #8086. |
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Classes like
MatAnchorin the button docs should indicate that those are extending theMatButtonclass.Clauses without any related Dgeni doc can be ignored, because no information for this is available (right now; e.g.
MatSlideToggleBasewith mixins)