build(docs-infra): render short description of parameters in API docs (#24537)

PR Close #24537
2018-06-15 13:36:30 +01:00 · 2018-06-15 13:36:30 +01:00 · d876700c26
parent 99bdd257a6
commit d876700c26
1 changed files with 1 additions and 2 deletions
--- a/aio/tools/transforms/templates/api/lib/paramList.html
+++ b/aio/tools/transforms/templates/api/lib/paramList.html
@ -21,8 +21,7 @@
      {% if showType %}<td class="param-type"><code>{$ parameter.type $}</code></td>{% endif %}
      <td class="param-description">
      {% marked %}
-      {% if parameter.description | trim %}{$ parameter.description $}
-
+      {% if (parameter.shortDescription | trim) or (parameter.description | trim) %}{$ parameter.shortDescription + '\n\n' + parameter.description $}
      {% elseif not showType and parameter.type %}<p>Type: <code>{$ parameter.type $}</code>.</p>
      {% endif %}