macro_rules! description {
($description:expr) => { ... };
}Expand description
Embed a description into a compiled Cargo subcommand, to be shown by cargo --list.
The following restrictions apply to a subcommand description:
- String length can be at most 280 bytes in UTF-8, although much shorter is better.
- Must not contain the characters
\n,\r, or\x1B(ESC).
Please consider running cargo --list and following the style of the
existing descriptions of the built-in Cargo subcommands.
§Example
// subcommand's main.rs
cargo_subcommand_metadata::description! {
"Draw a spiffy visualization of things"
}
fn main() {
/* … */
}