Mike Gerwitz

Activist for User Freedom

aboutsummaryrefslogtreecommitdiffstats
path: root/core
diff options
context:
space:
mode:
authorMike Gerwitz <mike.gerwitz@rtspecialty.com>2019-10-17 09:20:15 -0400
committerMike Gerwitz <mike.gerwitz@rtspecialty.com>2019-10-17 09:20:15 -0400
commite97f7a75c9258eb58e429c56492a40edb0cd57e0 (patch)
tree7b3b97eeea2b7979063b4ebcbcae977eb2c83410 /core
parent39c7161cca85a58c872c569f636c89a0e09a5735 (diff)
downloadtame-e97f7a75c9258eb58e429c56492a40edb0cd57e0.tar.gz
tame-e97f7a75c9258eb58e429c56492a40edb0cd57e0.tar.bz2
tame-e97f7a75c9258eb58e429c56492a40edb0cd57e0.zip
core/test/vector (_define-vector_): Require description
We want things to require documentation when possible.
Diffstat (limited to 'core')
-rw-r--r--core/test/core/vector/define.xml3
-rw-r--r--core/vector/define.xml5
2 files changed, 5 insertions, 3 deletions
diff --git a/core/test/core/vector/define.xml b/core/test/core/vector/define.xml
index 50129f6..1c1c5c0 100644
--- a/core/test/core/vector/define.xml
+++ b/core/test/core/vector/define.xml
@@ -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" />
diff --git a/core/vector/define.xml b/core/vector/define.xml
index 03f1652..a13b28a 100644
--- a/core/vector/define.xml
+++ b/core/vector/define.xml
@@ -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>