We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
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 clap-rs/clap#4500
One alternative is to pull a markdown file into your doc comment
e.g. #[doc = include_str!("../../README.md")]
#[doc = include_str!("../../README.md")]
The text was updated successfully, but these errors were encountered:
No branches or pull requests
I use clap, and I put examples in the documentation comments for my commands/subcommands like:
From discussion in clap-rs/clap#4500
e.g.
#[doc = include_str!("../../README.md")]
The text was updated successfully, but these errors were encountered: