Use doc not docs in cli
This commit is contained in:
Tom Jack
parent
adb4572bde
commit
32625bb075
@ -95,8 +95,8 @@ let compile_file =
|
||||
let term =
|
||||
Term.(const f $ source_file 0 $ entry_point 1 $ syntax $ display_format $ michelson_code_format) in
|
||||
let cmdname = "compile-contract" in
|
||||
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 doc = "Subcommand: compile a contract. See `ligo " ^ cmdname ^ " --help' for a list of options specific to this subcommand." in
|
||||
(term , Term.info ~doc cmdname)
|
||||
|
||||
let compile_parameter =
|
||||
let f source_file entry_point expression syntax display_format michelson_format =
|
||||
@ -109,8 +109,8 @@ let compile_parameter =
|
||||
let term =
|
||||
Term.(const f $ source_file 0 $ entry_point 1 $ expression "PARAMETER" 2 $ syntax $ display_format $ michelson_code_format) in
|
||||
let cmdname = "compile-parameter" in
|
||||
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 doc = "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 ~doc cmdname)
|
||||
|
||||
let compile_storage =
|
||||
let f source_file entry_point expression syntax display_format michelson_format =
|
||||
@ -123,8 +123,8 @@ let compile_storage =
|
||||
let term =
|
||||
Term.(const f $ source_file 0 $ entry_point 1 $ expression "STORAGE" 2 $ syntax $ display_format $ michelson_code_format) in
|
||||
let cmdname = "compile-storage" in
|
||||
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 doc = "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 ~doc cmdname)
|
||||
|
||||
let dry_run =
|
||||
let f source_file entry_point storage input amount sender source syntax display_format =
|
||||
@ -138,8 +138,8 @@ let dry_run =
|
||||
let term =
|
||||
Term.(const f $ source_file 0 $ entry_point 1 $ expression "PARAMETER" 2 $ expression "STORAGE" 3 $ amount $ sender $ source $ syntax $ display_format) in
|
||||
let cmdname = "dry-run" in
|
||||
let docs = "Subcommand: run a smart-contract with the given storage and input." in
|
||||
(term , Term.info ~docs cmdname)
|
||||
let doc = "Subcommand: run a smart-contract with the given storage and input." in
|
||||
(term , Term.info ~doc cmdname)
|
||||
|
||||
let run_function =
|
||||
let f source_file entry_point parameter amount sender source syntax display_format =
|
||||
@ -153,8 +153,8 @@ let run_function =
|
||||
let term =
|
||||
Term.(const f $ source_file 0 $ entry_point 1 $ expression "PARAMETER" 2 $ amount $ sender $ source $ syntax $ display_format) in
|
||||
let cmdname = "run-function" in
|
||||
let docs = "Subcommand: run a function with the given parameter." in
|
||||
(term , Term.info ~docs cmdname)
|
||||
let doc = "Subcommand: run a function with the given parameter." in
|
||||
(term , Term.info ~doc cmdname)
|
||||
|
||||
let evaluate_value =
|
||||
let f source_file entry_point amount sender source syntax display_format =
|
||||
@ -168,8 +168,8 @@ let evaluate_value =
|
||||
let term =
|
||||
Term.(const f $ source_file 0 $ entry_point 1 $ amount $ sender $ source $ syntax $ display_format) in
|
||||
let cmdname = "evaluate-value" in
|
||||
let docs = "Subcommand: evaluate a given definition." in
|
||||
(term , Term.info ~docs cmdname)
|
||||
let doc = "Subcommand: evaluate a given definition." in
|
||||
(term , Term.info ~doc cmdname)
|
||||
|
||||
let compile_expression =
|
||||
let f expression syntax display_format michelson_format =
|
||||
@ -184,8 +184,8 @@ let compile_expression =
|
||||
let term =
|
||||
Term.(const f $ expression "" 0 $ syntax $ display_format $ michelson_code_format) in
|
||||
let cmdname = "compile-expression" in
|
||||
let docs = "Subcommand: compile to a michelson value." in
|
||||
(term , Term.info ~docs cmdname)
|
||||
let doc = "Subcommand: compile to a michelson value." in
|
||||
(term , Term.info ~doc cmdname)
|
||||
|
||||
let run ?argv () =
|
||||
Term.eval_choice ?argv main [
|
||||
|
||||
@ -13,40 +13,35 @@ let%expect_test _ =
|
||||
SYNOPSIS
|
||||
ligo COMMAND ...
|
||||
|
||||
Subcommand: compile a contract. See `ligo compile-contract --help' for a list
|
||||
of options specific to this subcommand.
|
||||
COMMANDS
|
||||
compile-contract
|
||||
Subcommand: compile a contract. See `ligo compile-contract --help'
|
||||
for a list of options specific to this subcommand.
|
||||
|
||||
|
||||
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 compile-storage
|
||||
--help' for a list of options specific to this subcommand.
|
||||
compile-storage
|
||||
|
||||
|
||||
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 compile-parameter --help' for a list of options
|
||||
specific to this subcommand.
|
||||
compile-parameter
|
||||
|
||||
|
||||
Subcommand: compile to a michelson value.
|
||||
compile-expression
|
||||
Subcommand: compile to a michelson value.
|
||||
|
||||
compile-parameter
|
||||
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 compile-parameter
|
||||
--help' for a list of options specific to this subcommand.
|
||||
|
||||
Subcommand: evaluate a given definition.
|
||||
evaluate-value
|
||||
compile-storage
|
||||
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 compile-storage --help' for a list of options
|
||||
specific to this subcommand.
|
||||
|
||||
|
||||
Subcommand: run a function with the given parameter.
|
||||
run-function
|
||||
|
||||
|
||||
Subcommand: run a smart-contract with the given storage and input.
|
||||
dry-run
|
||||
Subcommand: run a smart-contract with the given storage and input.
|
||||
|
||||
evaluate-value
|
||||
Subcommand: evaluate a given definition.
|
||||
|
||||
run-function
|
||||
Subcommand: run a function with the given parameter.
|
||||
|
||||
OPTIONS
|
||||
--help[=FMT] (default=auto)
|
||||
@ -57,7 +52,9 @@ let%expect_test _ =
|
||||
run_ligo_good [ "compile-contract" ; "--help" ] ;
|
||||
[%expect {|
|
||||
NAME
|
||||
ligo-compile-contract
|
||||
ligo-compile-contract - Subcommand: compile a contract. See `ligo
|
||||
compile-contract --help' for a list of options specific to this
|
||||
subcommand.
|
||||
|
||||
SYNOPSIS
|
||||
ligo compile-contract [OPTION]... SOURCE_FILE ENTRY_POINT
|
||||
@ -97,7 +94,11 @@ let%expect_test _ =
|
||||
run_ligo_good [ "compile-parameter" ; "--help" ] ;
|
||||
[%expect {|
|
||||
NAME
|
||||
ligo-compile-parameter
|
||||
ligo-compile-parameter - 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
|
||||
compile-parameter --help' for a list of options specific to this
|
||||
subcommand.
|
||||
|
||||
SYNOPSIS
|
||||
ligo compile-parameter [OPTION]... SOURCE_FILE ENTRY_POINT
|
||||
@ -141,7 +142,11 @@ let%expect_test _ =
|
||||
run_ligo_good [ "compile-storage" ; "--help" ] ;
|
||||
[%expect {|
|
||||
NAME
|
||||
ligo-compile-storage
|
||||
ligo-compile-storage - 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 compile-storage --help' for a list of options
|
||||
specific to this subcommand.
|
||||
|
||||
SYNOPSIS
|
||||
ligo compile-storage [OPTION]... SOURCE_FILE ENTRY_POINT
|
||||
@ -185,7 +190,8 @@ let%expect_test _ =
|
||||
run_ligo_good [ "dry-run" ; "--help" ] ;
|
||||
[%expect {|
|
||||
NAME
|
||||
ligo-dry-run
|
||||
ligo-dry-run - Subcommand: run a smart-contract with the given storage
|
||||
and input.
|
||||
|
||||
SYNOPSIS
|
||||
ligo dry-run [OPTION]... SOURCE_FILE ENTRY_POINT PARAMETER_EXPRESSION
|
||||
@ -236,7 +242,8 @@ let%expect_test _ =
|
||||
run_ligo_good [ "run-function" ; "--help" ] ;
|
||||
[%expect {|
|
||||
NAME
|
||||
ligo-run-function
|
||||
ligo-run-function - Subcommand: run a function with the given
|
||||
parameter.
|
||||
|
||||
SYNOPSIS
|
||||
ligo run-function [OPTION]... SOURCE_FILE ENTRY_POINT
|
||||
@ -284,7 +291,7 @@ let%expect_test _ =
|
||||
run_ligo_good [ "evaluate-value" ; "--help" ] ;
|
||||
[%expect {|
|
||||
NAME
|
||||
ligo-evaluate-value
|
||||
ligo-evaluate-value - Subcommand: evaluate a given definition.
|
||||
|
||||
SYNOPSIS
|
||||
ligo evaluate-value [OPTION]... SOURCE_FILE ENTRY_POINT
|
||||
@ -328,7 +335,7 @@ let%expect_test _ =
|
||||
run_ligo_good [ "compile-expression" ; "--help" ] ;
|
||||
[%expect {|
|
||||
NAME
|
||||
ligo-compile-expression
|
||||
ligo-compile-expression - Subcommand: compile to a michelson value.
|
||||
|
||||
SYNOPSIS
|
||||
ligo compile-expression [OPTION]... _EXPRESSION
|
||||
|
||||
Loading…
Reference in New Issue
Block a user