Skip to content
This repository was archived by the owner on Dec 4, 2017. It is now read-only.

Commit 1ac2a42

Browse files
author
Eric Jimenez
committed
chore(not yet documented): remove placeholder to reduce noise
1 parent a9730db commit 1ac2a42

File tree

6 files changed

+18
-25
lines changed

6 files changed

+18
-25
lines changed

public/resources/css/module/_api.scss

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,7 @@ input.api-filter {
9898

9999
.h2-api-docs {
100100
font-size: 15px !important;
101+
line-height: 20px;
101102
text-transform: uppercase !important;
102103
color: #78909C !important;
103104
}
@@ -137,6 +138,13 @@ input.api-filter {
137138
}
138139
}
139140

141+
.openParens {
142+
margin-top: 15px;
143+
}
144+
145+
.endParens {
146+
margin-bottom: 20px !important;
147+
}
140148

141149
p {
142150

tools/api-builder/angular.io-package/templates/class.template.html

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
div(flex="20" flex-xs="100")
3232
h2(class="h2-api-docs") Class Overview
3333
div(flex="80" flex-xs="100")
34-
code(class="no-bg api-doc-code") class {$ doc.name $} {
34+
code(class="no-bg api-doc-code openParens") class {$ doc.name $} {
3535

3636
{% if doc.statics.length %}
3737
.div(layout="column")
@@ -58,7 +58,7 @@
5858
code(class="api-doc-code") {$ paramList(member.parameters) | indent(8, false) | trim $}{$ returnType(member.returnType) $}
5959
{% endif %}{% endfor %}
6060
{% endif %}
61-
p.selector
61+
p(class="selector endParens")
6262
code(class="api-doc-code no-bg") }
6363

6464
{% block additional %}
@@ -71,8 +71,6 @@
7171
:marked
7272
{%- if doc.description.length > 2 %}
7373
{$ doc.description | indentForMarkdown(6) | trimBlankLines $}
74-
{% else %}
75-
*Not yet documented*
7674
{% endif %}
7775

7876
.div(layout="row" layout-xs="column" class="row-margin ng-cloak")
@@ -94,9 +92,7 @@
9492
code(class="api-doc-code")
9593
@{$ decorator.name $}{$ paramList(decorator.arguments) | indent(10, false) $}
9694
:marked
97-
{%- if decorator.notYetDocumented %}
98-
*Not yet documented*
99-
{% else %}
95+
{%- if not decorator.notYetDocumented %}
10096
{$ decorator.description | indentForMarkdown(8) | trimBlankLines $}
10197
{% endif %}
10298
{% endfor %}
@@ -113,9 +109,7 @@
113109
code(class="api-doc-code").
114110
{$ doc.constructorDoc.name $}{$ paramList(doc.constructorDoc.parameters) | indent(8, false) | trim $}
115111
:marked
116-
{%- if doc.constructorDoc.notYetDocumented %}
117-
*Not yet documented*
118-
{% else %}
112+
{%- if not doc.constructorDoc.notYetDocumented %}
119113
{$ doc.constructorDoc.description | indentForMarkdown(6) | replace('### Example', '') | replace('## Example', '') | replace('# Example', '') | trimBlankLines $}
120114
{% endif %}
121115
{% endif %}
@@ -131,9 +125,7 @@
131125
code(class="api-doc-code").
132126
{$ member.name $}{$ paramList(member.parameters) | indent(8, false) | trim $}{$ returnType(member.returnType) $}
133127
:marked
134-
{%- if member.notYetDocumented %}
135-
*Not yet documented*
136-
{% else %}
128+
{%- if not member.notYetDocumented %}
137129
{$ member.description | indentForMarkdown(6) | replace('### Example', '') | replace('## Example', '') | replace('# Example', '') | trimBlankLines $}
138130
{% endif %}
139131

@@ -156,9 +148,7 @@
156148
{$ member.name $}{$ paramList(member.parameters) | indent(8, false) | trim $}{$ returnType(member.returnType) $}
157149

158150
:marked
159-
{%- if member.notYetDocumented %}
160-
*Not yet documented*
161-
{% else %}
151+
{%- if not member.notYetDocumented %}
162152
{$ member.description | indentForMarkdown(6) | replace('### Example', '') | replace('## Example', '') | replace('# Example', '') | trimBlankLines $}
163153
{% endif -%}
164154

tools/api-builder/angular.io-package/templates/decorator.template.html

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,7 @@
1313
code.
1414
export {$ doc.name $}(options : {@link {$ doc.decoratorType $} {$ doc.decoratorType | escape $}}){$ returnType(doc.returnType) $}
1515
:marked
16-
{%- if doc.notYetDocumented %}
17-
*Not yet documented*
18-
{% else %}
16+
{%- if not doc.notYetDocumented %}
1917
{$ doc.description | indentForMarkdown(6) | trimBlankLines $}
2018
{% endif %}
2119

tools/api-builder/angular.io-package/templates/function.template.html

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,7 @@
1313
code.
1414
export {$ doc.name $}{$ paramList(doc.parameters) | indent(8, true) | trim $}{$ returnType(doc.returnType) $}
1515
:marked
16-
{%- if doc.notYetDocumented %}
17-
*Not yet documented*
18-
{% else %}
16+
{%- if not doc.notYetDocumented %}
1917
{$ doc.description | indentForMarkdown(6) | trimBlankLines $}
2018
{% endif %}
2119

tools/api-builder/angular.io-package/templates/var.template.html

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,7 @@
1313
code.
1414
export {$ doc.name $}{$ returnType(doc.returnType) $}
1515
:marked
16-
{%- if doc.notYetDocumented %}
17-
*Not yet documented*
18-
{% else %}
16+
{%- if not doc.notYetDocumented %}
1917
{$ doc.description | indentForMarkdown(6) | trimBlankLines $}
2018
{% endif %}
2119

tools/api-builder/docs-package/processors/addNotYetDocumentedProperty.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ module.exports = function addNotYetDocumentedProperty(EXPORT_DOC_TYPES, log, cre
2323
}
2424

2525
if (doc.notYetDocumented) {
26+
// TODO: (ericjim) should I remove this?
2627
log.warn(createDocMessage("Not yet documented", doc));
2728
}
2829
});

0 commit comments

Comments
 (0)