trycmd
trycmd copied to clipboard
Support for test cases in documentation comments
I use clap, and I put examples in the documentation comments for my commands/subcommands like:
enum Commands {
/// Counts from START to STOP.
///
/// $ mycli counter 1 3
/// 1
/// 2
/// 3
Counter {
start: usize,
stop: usize,
}
}
From discussion in https://github.com/clap-rs/clap/discussions/4500
One alternative is to pull a markdown file into your doc comment
e.g. #[doc = include_str!("../../README.md")]