Replace "Common" with "Available" in help text.

"Common options" was intended as "all except internal", but it could be interpreted as "global options" for a parser with commands. Remove the possible confusion by using "Available options" instead, which is also consistent with the label used for commands.
pcapriotti · Jul 30, 2012 · 0915084 · 0915084
1 parent 185a7d4
commit 0915084
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 5 deletions.
diff --git a/Options/Applicative/Help.hs b/Options/Applicative/Help.hs
@@ -96,7 +96,7 @@ parserHelpText pprefs pinfo = unlines
   ++ [ "  " ++ line | line <- nn [pinfo^.infoProgDesc] ]
   ++ [ line | let opts = fullDesc pprefs p
             , not (null opts)
-            , line <- ["", "Common options:"] ++ opts
+            , line <- ["", "Available options:"] ++ opts
             , pinfo^.infoFullDesc ]
   ++ [ line | let cmds = cmdDesc p
             , not (null cmds)

diff --git a/README.md b/README.md
@@ -59,7 +59,7 @@ help text:
     Usage: hello --hello TARGET [--quiet]
       Print a greeting for TARGET
 
-    Common options:
+    Available options:
       -h,--help                Show this help text
       --hello TARGET           Target for the greeting
       --quiet                  Whether to be quiet

diff --git a/optparse-applicative.cabal b/optparse-applicative.cabal
@@ -54,7 +54,7 @@ description:
  >Usage: hello --hello TARGET [--quiet]
  >  Print a greeting for TARGET
  >
- >Common options:
+ >Available options:
  >  -h,--help                Show this help text
  >  --hello TARGET           Target for the greeting
  >  --quiet                  Whether to be quiet

diff --git a/tests/cabal.err.txt b/tests/cabal.err.txt
@@ -1,7 +1,7 @@
 Usage: cabal configure [--enable-tests] [-f|--flags FLAGS]
   Prepare to build the package
 
-Common options:
+Available options:
   --enable-tests           Enable compilation of test suites
   -f,--flags FLAGS         Enable the given flag
   -h,--help                Show this help text
diff --git a/tests/hello.err.txt b/tests/hello.err.txt
@@ -3,7 +3,7 @@ hello - a test for optparse-applicative
 Usage: hello --hello TARGET [--quiet]
   Print a greeting for TARGET
 
-Common options:
+Available options:
   --hello TARGET           Target for the greeting
   --quiet                  Whether to be quiet
   -h,--help                Show this help text