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

chore(docs): adds types column and null checks for description #7713

Merged
merged 2 commits into from
Oct 27, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions tools/dgeni/templates/method.template.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,13 @@
</th>
</tr>
</thead>
{%- if method.description -%}
<tr class="docs-api-method-description-row">
<td colspan="2" class="docs-api-method-description-cell">
{$ method.description | marked | safe $}
</td>
</tr>
{%- endif -%}

{%- if method.params.length -%}
<thead>
Expand Down
8 changes: 6 additions & 2 deletions tools/dgeni/templates/property.template.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,11 @@
<p class="docs-api-property-name">
{$ property.name $}
</p>
<code class="docs-api-property-type">{$ property.type $}</code>
</td>
<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>
Copy link
Member

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

Copy link
Contributor Author

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.

Copy link
Member

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?

</div>
{$ property.description | marked | safe $}
</td>
</tr>