rust: Documenting and writing helptext for Structopt CLI instructions and flags

(*1*)

if we run shipment run -- --help, we will be able to see that structopt
thinks the title of our binary continues to be the package deal title.
We will be able to alternate that with some other characteristic macro on our
struct.

digital-garden 0.1.0 USAGE: backyard <SUBCOMMAND> FLAGS: -h, --help Prints assist data -V, --version Prints edition data SUBCOMMANDS: assist Prints this message or the assistance of the given subcommand(s) write

Additionally realize that within the assist textual content the assist subcommand
has some useful output whilst write has none:

backyard 0.1.0 USAGE: backyard <SUBCOMMAND> FLAGS: -h, --help Prints assist data -V, --version Prints edition data SUBCOMMANDS: assist Prints this message or the assistance of the given subcommand(s) write

There are a selection of puts we will be able to put document feedback.
We will be able to write at the Choose struct for international data
in regards to the CLI.

We will be able to additionally write on every subcommand and even the choices
for every subcommand.

/// A CLI for the rising and curation of a electronic backyard
///
/// Consult with https://www.rustadventure.rs/backyard for extra!
struct Choose { #[structopt(subcommand)] cmd: Command,
}
enum Command { /// write one thing to your backyard /// /// This command will open your $EDITOR, watch for you /// to write down one thing, after which save the record in your /// backyard Write { /// Optionally set a identify for what you're going to write about #[structopt(short, long)] identify: Possibility<String>, },
}

Every of those ends up in documentation going to the related
position within the CLI assist textual content. Word particularly that the primary
line of document remark for subcommands is proven as “brief”
assist textual content, whilst the entire textual content is reserved for working
--help immediately at the subcommand.

❯ shipment run
backyard 0.1.0
A CLI for the rising and curation of a electronic backyard Consult with https://www.rustadventure.rs/backyard for extra! USAGE: backyard <SUBCOMMAND> FLAGS: -h, --help Prints assist data -V, --version Prints edition data SUBCOMMANDS: assist Prints this message or the assistance of the given subcommand(s) write write one thing to your backyard
❯ shipment run -- write --help
garden-write 0.1.0
write one thing to your backyard This command will open your $EDITOR, wait so that you can write one thing, after which save the record in your backyard USAGE: backyard write [OPTIONS] FLAGS: -h, --help Prints assist data -V, --version Prints edition data OPTIONS: -t, --title <identify> Optionally set a identify for what you're going to write about

Additionally observe that -h and --help are no longer the similar factor in relation to structopt.