Browse Source

Update docstrings

Alois Mahdal 6 years ago
parent
commit
0959d68245
1 changed files with 4 additions and 4 deletions
  1. 4
    4
      src/jat.sh.skel

+ 4
- 4
src/jat.sh.skel View File

131
 
131
 
132
 jat__cmd() {
132
 jat__cmd() {
133
     #
133
     #
134
-    # Assert that command $@ returns zero (or other)
134
+    # Assert that command $@ exits with zero (or other)
135
     #
135
     #
136
     # Usage:
136
     # Usage:
137
     #
137
     #
211
 
211
 
212
 jat__cmp() {
212
 jat__cmp() {
213
     #
213
     #
214
-    # Assert that value $@ returns zero (or other)
214
+    # Assert comparison of $1 and $3 using operator $2
215
     #
215
     #
216
     # Usage:
216
     # Usage:
217
     #
217
     #
268
 
268
 
269
 jat__eval() {
269
 jat__eval() {
270
     #
270
     #
271
-    # Assert that command in code $1 returns zero (or other)
271
+    # Assert that code $1 exits with zero (or other)
272
     #
272
     #
273
     # Usage:
273
     # Usage:
274
     #
274
     #
275
-    #     jat__eval [-s R_ESF] [-S ES_EXPR] [--] CODE
275
+    #     jat__eval [assert-options] [-s R_ESF] [-S ES_EXPR] [--] CODE
276
     #
276
     #
277
     # Run CODE using eval builtin and if exit status is zero, announce assertion
277
     # Run CODE using eval builtin and if exit status is zero, announce assertion
278
     # success (PASS), otherwise announce assertion failure (FAIL).
278
     # success (PASS), otherwise announce assertion failure (FAIL).