Browse Source

Update and clarify docstring for _pretty__echo_usage()

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

+ 4
- 2
src/include-bash/pretty.sh View File

@@ -465,6 +465,8 @@ _pretty__echo_usage() {
465 465
     #  *  command mode (`-c`) prints "commands:" header and
466 466
     #     indents next arguments,
467 467
     #
468
+    #  *  indent mode (`-i`) just indents next arguments,
469
+    #
468 470
     #  *  plain mode (`--`) prints empty line (new paragraph)
469 471
     #     and turns indentations off.
470 472
     #
@@ -474,8 +476,8 @@ _pretty__echo_usage() {
474 476
     #
475 477
     #     A special case of usage mode is when only single
476 478
     #     argument is passed to this function; then instead
477
-    #     of "usage:" header, this usage pattern is prefixed
478
-    #     with the same string.
479
+    #     printing "usage:" header on separate string, it is
480
+    #     joined with the argument to single line.
479 481
     #
480 482
     # In order to help avoid (rare) conflict between mkusage()
481 483
     # switches and your usage patterns, the very first argument,