Browse Source

Correct documentation

 + Make ending dots more consistent. Core generated command description
 (like "help") doesn't have a trailing dot, hence we remove these
 trailing dot from ours.
 + Correct typo.
Leo 8 years ago
parent
commit
7aefbadd04
1 changed files with 5 additions and 5 deletions
  1. 5 5
      src/command_def.ml

+ 5 - 5
src/command_def.ml

@@ -100,7 +100,7 @@ let shared_params =
   <*> flag "-v" (optional_with_default !Const.verbosity int)
   <*> flag "-v" (optional_with_default !Const.verbosity int)
         ~aliases:["--verbose" ; "-verbose"]
         ~aliases:["--verbose" ; "-verbose"]
         ~doc:"[n] Set verbosity level. \
         ~doc:"[n] Set verbosity level. \
-              The higher n is, the most verbose the program is."
+              The higher n is, the more verbose the program is."
   (* Flag to assume yes *)
   (* Flag to assume yes *)
   <*> flag "-y" no_arg
   <*> flag "-y" no_arg
         ~aliases:["--yes" ; "-yes"]
         ~aliases:["--yes" ; "-yes"]
@@ -161,7 +161,7 @@ let reset =
 ;;
 ;;
 let reset_all =
 let reset_all =
   basic
   basic
-    ~summary:" Reinitialises launches for everything."
+    ~summary:" Reinitialises launches for everything"
     Spec.(
     Spec.(
       empty
       empty
       +> shared_params
       +> shared_params
@@ -175,7 +175,7 @@ let reset_all =
 let list =
 let list =
   basic
   basic
     ~summary:"Print a list of all commands with their number. Useful to launch with number. \
     ~summary:"Print a list of all commands with their number. Useful to launch with number. \
-              Displays a star next to next command to launch."
+              Displays a star next to next command to launch"
     Spec.(
     Spec.(
       empty
       empty
       +> shared_params
       +> shared_params
@@ -192,7 +192,7 @@ let list =
 let clean =
 let clean =
   basic
   basic
     ~summary:"Remove doubled entries, trailing spaces in them... \
     ~summary:"Remove doubled entries, trailing spaces in them... \
-              Useful after manual editing or with rc file from old version."
+              Useful after manual editing or with rc file from old version"
     Spec.(
     Spec.(
       empty
       empty
       +> shared_params
       +> shared_params
@@ -243,7 +243,7 @@ let delete =
 (* To display current state *)
 (* To display current state *)
 let state =
 let state =
   basic
   basic
-    ~summary:"Display current state of the program."
+    ~summary:"Display current state of the program"
     Spec.(
     Spec.(
       empty
       empty
       +> shared_params
       +> shared_params