Rename desc argument to doc

This is to avoid confusion with the `description` field of manpages.

Signed-off-by: Stephen Sherratt <[email protected]>

Author: gridbugs

CHANGES.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Changed
+
+- Rename `desc` in APIs to `doc` to avoid confusion with the `description` field of manpages. (#12)
+
 ## 0.4.0
 
 ### Added

examples/echo_ansi.ml

@@ -41,16 +41,16 @@ let main ~bold ~underline ~color words =
 
 let () =
   let command =
-    Command.singleton ~desc:"Echo with style!"
+    Command.singleton ~doc:"Echo with style!"
     @@
     let open Arg_parser in
-    (* Describe and parse the command line arguments:*)
-    let+ bold = flag [ "bold" ] ~desc:"Make the text bold"
-    and+ underline = flag [ "underline" ] ~desc:"Underline the text"
-    and+ color = named_opt [ "color" ] Color.conv ~desc:"Set the text color"
+    (* Describe and parse the command line arguments: *)
+    let+ bold = flag [ "bold" ] ~doc:"Make the text bold"
+    and+ underline = flag [ "underline" ] ~doc:"Underline the text"
+    and+ color = named_opt [ "color" ] Color.conv ~doc:"Set the text color"
     and+ words = pos_all string
     and+ completion =
-      flag [ "completion" ] ~desc:"Print this program's completion script and exit"
+      flag [ "completion" ] ~doc:"Print this program's completion script and exit"
     in
     if completion
     then `Completion
@@ -60,11 +60,11 @@ let () =
      that we should print the completion script. *)
   let help_style =
     let open Help_style in
-    { program_desc = { ansi_style_plain with color = Some `Green }
+    { program_doc = { ansi_style_plain with color = Some `Green }
     ; usage = { ansi_style_plain with color = Some `Yellow }
     ; section_heading = { ansi_style_plain with color = Some `Red }
     ; arg_name = { ansi_style_plain with color = Some `Blue }
-    ; arg_desc = { ansi_style_plain with color = Some `Cyan }
+    ; arg_doc = { ansi_style_plain with color = Some `Cyan }
     }
   in
   match

examples/fake_git.ml

@@ -27,17 +27,17 @@ let checkout =
 
 let commit =
   let open Arg_parser in
-  let+ _amend = flag [ "amend" ] ~desc:"Amend a commit"
-  and+ _all = flag [ "a" ] ~desc:"Commit all changes"
+  let+ _amend = flag [ "amend" ] ~doc:"Amend a commit"
+  and+ _all = flag [ "a" ] ~doc:"Commit all changes"
   and+ _branch = named_opt [ "b"; "branch" ] branch_conv
   and+ _message =
     named_opt
       [ "m"; "message" ]
       string
-      ~desc:
+      ~doc:
         "The commit message. This description is extra long to exercise text wrapping in \
          help messages."
-  and+ _files = pos_all file ~desc:"The files to commit" in
+  and+ _files = pos_all file ~doc:"The files to commit" in
   ()
 ;;
 
@@ -47,7 +47,7 @@ let log =
     named_opt
       [ "pretty"; "p" ]
       (string_enum [ "full"; "fuller"; "short"; "oneline" ])
-      ~desc:"foo"
+      ~doc:"foo"
   in
   ()
 ;;
@@ -65,18 +65,18 @@ let () =
   let open Command in
   group
     ~prose:(Manpage.prose ~description:[] ())
-    ~desc:"Fake version control"
-    [ subcommand "config" (singleton Arg_parser.unit ~desc:"Configure the tool.")
-    ; subcommand "checkout" (singleton checkout ~desc:"Check out a revision.")
-    ; subcommand "commit" (singleton commit ~desc:"Commit your changes.")
-    ; subcommand "log" (singleton log ~desc:"List recent commits.")
+    ~doc:"Fake version control"
+    [ subcommand "config" (singleton Arg_parser.unit ~doc:"Configure the tool.")
+    ; subcommand "checkout" (singleton checkout ~doc:"Check out a revision.")
+    ; subcommand "commit" (singleton commit ~doc:"Commit your changes.")
+    ; subcommand "log" (singleton log ~doc:"List recent commits.")
     ; subcommand
         "bisect"
         (group
            ~default_arg_parser:bisect_common
-           ~desc:"Binary search through previous commits."
-           [ subcommand "start" (singleton bisect_common ~desc:"Start a bisect.")
-           ; subcommand "reset" (singleton bisect_common ~desc:"Stop a bisect.")
+           ~doc:"Binary search through previous commits."
+           [ subcommand "start" (singleton bisect_common ~doc:"Start a bisect.")
+           ; subcommand "reset" (singleton bisect_common ~doc:"Stop a bisect.")
            ])
     ; subcommand ~hidden:true "__internal" print_completion_script_bash
     ]

examples/sum.ml

@@ -3,7 +3,7 @@ open Climate
 
 let main =
   let open Arg_parser in
-  let+ args = pos_all int ~desc:"The ints to be summed" in
+  let+ args = pos_all int ~doc:"The ints to be summed" in
   print_endline (Printf.sprintf "%d" (List.fold_left args ~init:0 ~f:( + )))
 ;;
 

examples/sum2.ml

@@ -2,8 +2,8 @@ open Climate
 
 let main =
   let open Arg_parser in
-  let+ a = pos_req 0 int ~value_name:"LHS" ~desc:"The left hand side of the operation"
-  and+ b = pos_req 1 int ~value_name:"RHS" ~desc:"The right hand side of the operation" in
+  let+ a = pos_req 0 int ~value_name:"LHS" ~doc:"The left hand side of the operation"
+  and+ b = pos_req 1 int ~value_name:"RHS" ~doc:"The right hand side of the operation" in
   print_endline (Printf.sprintf "%d" (a + b))
 ;;