Rename print-synopsis to print-help

Author: cgay

command-line-parser.dylan

@@ -754,7 +754,7 @@ define function process-tokens
         if (instance?(option, <help-option>))
           // Handle --help early in case the remainder of the command line is
           // invalid or there are missing required arguments.
-          print-synopsis(parser, subcmd);
+          print-help(parser, subcmd);
           abort-command(0);
         end;
         parse-option(option, parser);

help.dylan

@@ -68,12 +68,12 @@ define method execute-subcommand
   if (name)
     let subcmd = find-subcommand(parser, name);
     if (subcmd)
-      print-synopsis(parser, subcmd);
+      print-help(parser, subcmd);
     else
       usage-error("Subcommand %= not found.", name);
     end;
   else
-    print-synopsis(parser, #f);     // 'app help' same as 'app --help'
+    print-help(parser, #f);     // 'app help' same as 'app --help'
   end;
 end method;
 
@@ -146,10 +146,10 @@ define method format-option-usage
   option.canonical-option-name
 end;
 
-define open generic print-synopsis
+define open generic print-help
     (parser :: <command-line-parser>, subcmd :: false-or(<subcommand>), #key stream);
 
-define method print-synopsis
+define method print-help
     (parser :: <command-line-parser>, subcmd == #f,
      #key stream :: <stream> = *standard-output*)
   format(stream, "%s\n", parser.command-help);
@@ -177,7 +177,7 @@ define method print-synopsis
   end;
 end method;
 
-define method print-synopsis
+define method print-help
     (parser :: <command-line-parser>, subcmd :: <subcommand>,
      #key stream :: <stream> = *standard-output*)
   format(stream, "%s\n", subcmd.command-help);

library.dylan

@@ -69,7 +69,7 @@ define module command-line-parser
     add-option,
     parse-command-line,
     get-option-value,
-    print-synopsis,
+    print-help,
 
     parse-option-value;
 

tests/command-line-parser-test-suite.dylan

@@ -89,7 +89,7 @@ end test test-command-line-parser;
 define test test-synopsis-format ()
   let parser = make-parser();
   let synopsis = with-output-to-string (stream)
-                   print-synopsis(parser, #f, stream: stream)
+                   print-help(parser, #f, stream: stream)
                  end;
   let expected = #:str:"x