improved --help docs

This commit is contained in:
Georges Dupéron 2019-06-05 19:17:42 +02:00
parent 347774e42b
commit da4e3e5b80

View File

@ -53,8 +53,9 @@ let compile_file =
in in
let term = let term =
Term.(const f $ source $ entry_point $ syntax) in Term.(const f $ source $ entry_point $ syntax) in
let docs = "Compile contracts." in let cmdname = "compile-contract" in
(term , Term.info ~docs "compile-contract") let docs = "Subcommand: compile a contract. See `ligo " ^ cmdname ^ " --help' for a list of options specific to this subcommand." in
(term , Term.info ~docs cmdname)
let compile_parameter = let compile_parameter =
let f source entry_point expression syntax = let f source entry_point expression syntax =
@ -67,8 +68,9 @@ let compile_parameter =
in in
let term = let term =
Term.(const f $ source $ entry_point $ expression $ syntax) in Term.(const f $ source $ entry_point $ expression $ syntax) in
let docs = "Compile contracts parameters." in let cmdname = "compile-parameter" in
(term , Term.info ~docs "compile-parameter") let docs = "Subcommand: compile parameters to a michelson expression. The resulting michelson expression can be passed as an argument in a transaction which calls a contract. See `ligo " ^ cmdname ^ " --help' for a list of options specific to this subcommand." in
(term , Term.info ~docs cmdname)
let compile_storage = let compile_storage =
let f source entry_point expression syntax = let f source entry_point expression syntax =
@ -81,8 +83,9 @@ let compile_storage =
in in
let term = let term =
Term.(const f $ source $ entry_point $ expression $ syntax) in Term.(const f $ source $ entry_point $ expression $ syntax) in
let docs = "Compile contracts storage." in let cmdname = "compile-storage" in
(term , Term.info ~docs "compile-storage") let docs = "Subcommand: compile an initial storage in ligo syntax to a michelson expression. The resulting michelson expression can be passed as an argument in a transaction which originates a contract. See `ligo " ^ cmdname ^ " --help' for a list of options specific to this subcommand." in
(term , Term.info ~docs cmdname)
let () = Term.exit @@ Term.eval_choice main [compile_file ; compile_parameter ; compile_storage] let () = Term.exit @@ Term.eval_choice main [compile_file ; compile_parameter ; compile_storage]