core/test/vector (_define-vector_): Require description

We want things to require documentation when possible.
master
Mike Gerwitz 2019-10-17 09:20:15 -04:00
parent 39c7161cca
commit e97f7a75c9
2 changed files with 5 additions and 3 deletions

View File

@ -30,7 +30,8 @@
<t:describe name="_define-vector_">
<t:it desc="defines a global vector">
<t:define-vector generates="testVector">
<t:define-vector generates="testVector"
desc="Test vector">
<c:vector>
<c:value-of name="#1" />
<c:value-of name="#2" />

View File

@ -43,20 +43,21 @@
desc="Define a vector with an arbitrary value">
<param name="@values@" desc="Definition" />
<param name="@generates@" desc="Vector name" />
<param name="@desc@" desc="Vector description" />
<rate yields="_{@generates@}">
<c:let>
<c:values>
<c:value name="value" type="float" set="vector"
desc="Value to produce">
desc="{@desc@} (intermediate value)">
<param-copy name="@values@" />
</c:value>
</c:values>
<!-- effectively means @generates@ = value -->
<c:sum of="value" generates="@generates@" index="k"
desc="Return value">
desc="@desc@">
<c:value-of name="value" index="k" />
</c:sum>
</c:let>