Skip to content

Commit c3b2ef2

Browse files
committed
Update command-line help
1 parent 9b26c30 commit c3b2ef2

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

src/main.rs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,12 @@ fn main() {
5656
.action(ArgAction::Version))
5757
.subcommand(
5858
Command::new("check")
59-
.about("Syntax- and type-check the given procedure")
59+
.about("Validate the syntax, structure, and types in the given Technique document.")
6060
.arg(
6161
Arg::new("watch")
6262
.long("watch")
6363
.action(clap::ArgAction::SetTrue)
64-
.help("Watch the given procedure file and recompile if changes are detected."),
64+
.help("Watch the given file containing a Technique document and recompile if changes are detected."),
6565
)
6666
.arg(
6767
Arg::new("output")
@@ -75,12 +75,12 @@ fn main() {
7575
.arg(
7676
Arg::new("filename")
7777
.required(true)
78-
.help("The file containing the code for the procedure you want to type-check."),
78+
.help("The file containing the code for the Technique you want to type-check."),
7979
),
8080
)
8181
.subcommand(
8282
Command::new("format")
83-
.about("Code format the given procedure")
83+
.about("Format the code in the given Technique document.")
8484
.arg(
8585
Arg::new("raw-control-chars")
8686
.short('R')
@@ -100,29 +100,29 @@ fn main() {
100100
.arg(
101101
Arg::new("filename")
102102
.required(true)
103-
.help("The file containing the code for the procedure you want to format."),
103+
.help("The file containing the code for the Technique you want to format."),
104104
),
105105
)
106106
.subcommand(
107107
Command::new("render")
108-
.about("Render the Technique procedure into a printable PDF")
109-
.long_about("Render the Technique procedure into a printable \
108+
.about("Render the Technique document into a printable PDF.")
109+
.long_about("Render the Technique document into a printable \
110110
PDF. By default this will highlight the source of the \
111111
input file for the purposes of reviewing the raw \
112-
procedure.")
112+
procedure in code form.")
113113
.arg(
114114
Arg::new("output")
115115
.short('o')
116116
.long("output")
117117
.value_parser(["typst", "none"])
118118
.default_value("none")
119119
.action(ArgAction::Set)
120-
.help("Output format: pdf (default) or typst markup.")
120+
.help("Which kind of diagnostic output to print when rendering.")
121121
)
122122
.arg(
123123
Arg::new("filename")
124124
.required(true)
125-
.help("The file containing the code for the procedure you want to print."),
125+
.help("The file containing the code for the Technique you want to print."),
126126
),
127127
)
128128
.get_matches();

0 commit comments

Comments
 (0)