Browse Source

Mention usage error templates in mkusage() docstring

Alois Mahdal 4 years ago
parent
commit
fc20097925
1 changed files with 8 additions and 1 deletions
  1. 8
    1
      src/include-bash/pretty.sh

+ 8
- 1
src/include-bash/pretty.sh View File

@@ -135,7 +135,14 @@ mkusage() {
135 135
     #
136 136
     # Optionally, you can add -w MSG to add clarifying message
137 137
     # (presented as warning) to help user understand what is
138
-    # wrong with arguments they have passed.
138
+    # wrong with arguments they have passed.  Alternatively,
139
+    # -m SUBJ, -M SUBJ, -u SUBJ, and -U SUBJ are shorthands for
140
+    # error messages describing missing positional argument (-m),
141
+    # missing value to a parametrized argument (-M), unknown
142
+    # argument (-u) or unknown command (-U).  Using these
143
+    # shorthands you don't need  to provide whole message, but
144
+    # only subject in question; rest of the message is provided
145
+    # by pretty.sh.
139 146
     #
140 147
     # Use "--" to delimit end of arguments processed by mkusage.
141 148
     #