Skip to content

Commit ab55ffc

Browse files
committed
document command-line options
1 parent 3b26105 commit ab55ffc

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

mdbook-goals/src/main.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,16 @@ struct Opt {
2424
#[derive(StructOpt, Debug)]
2525
#[allow(dead_code)]
2626
enum Command {
27+
/// Command used by mdbook to check if the preprocessor supports a renderer
2728
Supports { renderer: String },
2829

30+
/// Print the comment required to initiate FCP
2931
FCP { path: PathBuf },
3032

33+
/// Print the RFC text to stdout
3134
RFC { path: PathBuf },
3235

36+
/// Checks that the goal documents are well-formed, intended for use within CI
3337
Check {},
3438
}
3539

0 commit comments

Comments
 (0)