-
Notifications
You must be signed in to change notification settings - Fork 6.7k
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
chore(docs): adds types column and null checks for description #7713
Conversation
Could you include a screenshot of how this looks? How does it fit on mobile? |
I'm not a huge fan of how much horizontal space it takes up now; any ideas around how we can keep the name and the type in the same vertical space next to the description? |
From angular/material.angular.io#287 (comment), would you consider moving the type to the description cell and making it distinct via font weight and padding? Just instead of "Return Value:", have it sat "Type:" |
That could work- I do want to try emphasizing the type by using a monospace font with a different color rather than writing out |
Here is the updated look: It requires: angular/material.angular.io#292 |
<td class="docs-api-property-description">{$ property.description | marked | safe $}</td> | ||
<td class="docs-api-property-description"> | ||
<div class="docs-api-property-type"> | ||
Type: <code>{$ property.type $}</code> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not a huge fan of having "Type: " explicitly. Repeated text like this creates a lot of visual noise
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Gotcha. Should I just remove type and leave it like is otherwise.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you post a SS of what that looks like?
What if we add it line with the name, TypeScript syntax style?
|
@jelbourn - That doesn't look bad -> |
I do like that more |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@amcdnl can you re-create this PR? It was merged before final changes could be made |
Done in #8125 |
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. |
This PR: