Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2024-11-15 09:07:10 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #4154 from epage/help

Browse source 
docs: Fix up for changing of help output
This commit is contained in:
Ed Page 2022-08-31 08:48:05 -05:00 committed by GitHub
commit c2f9ecde18
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 47 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG.md
View file

@ -46,7 +46,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
- Removed lifetimes from `Command`, `Arg`, `ArgGroup`, and `PossibleValue` - Removed lifetimes from `Command`, `Arg`, `ArgGroup`, and `PossibleValue`
- *(help)* Make `DeriveDisplayOrder` the default and removed the setting. To sort help, set `next_display_order(None)` (#2808) - *(help)* Make `DeriveDisplayOrder` the default and removed the setting. To sort help, set `next_display_order(None)` (#2808)
- *(help)* Subcommand display order respects `Command::next_display_order` instead of `DeriveDisplayOrder` and using its own initial display order value (#2808) - *(help)* Subcommand display order respects `Command::next_display_order` instead of `DeriveDisplayOrder` and using its own initial display order value (#2808)
- *(help)* Help headings are now title cased, making any user-provided help headings inconsistent - *(help)* Help headings are now title cased, making any user-provided help headings inconsistent. To get the old behavior, see `Command::help_template`, `Arg::help_heading`, and `Command::subcommand_help_heading`
- *(env)* Parse `--help` and `--version` like any `ArgAction::SetTrue` flag (#3776) - *(env)* Parse `--help` and `--version` like any `ArgAction::SetTrue` flag (#3776)
- *(derive)* Changed the default for arguments from `parse` to `value_parser`., removing `parse` support - *(derive)* Changed the default for arguments from `parse` to `value_parser`., removing `parse` support
- *(derive)* `subcommand_required(true).arg_required_else_help(true)` is set instead of `SubcommandRequiredElseHelp` (#3280) - *(derive)* `subcommand_required(true).arg_required_else_help(true)` is set instead of `SubcommandRequiredElseHelp` (#3280)

42
src/builder/arg.rs
View file

@ -1072,10 +1072,10 @@ impl Arg {
/// ```text /// ```text
/// valnames /// valnames
/// ///
/// USAGE: /// Usage:
/// valnames [OPTIONS] /// valnames [OPTIONS]
/// ///
/// OPTIONS: /// Options:
/// --config <FILE> Some help text /// --config <FILE> Some help text
/// -h, --help Print help information /// -h, --help Print help information
/// -V, --version Print version information /// -V, --version Print version information
@ -1129,10 +1129,10 @@ impl Arg {
/// ```text /// ```text
/// valnames /// valnames
/// ///
/// USAGE: /// Usage:
/// valnames [OPTIONS] /// valnames [OPTIONS]
/// ///
/// OPTIONS: /// Options:
/// -h, --help Print help information /// -h, --help Print help information
/// --io-files <INFILE> <OUTFILE> Some help text /// --io-files <INFILE> <OUTFILE> Some help text
/// -V, --version Print version information /// -V, --version Print version information
@ -1910,10 +1910,10 @@ impl Arg {
/// ```notrust /// ```notrust
/// helptest /// helptest
/// ///
/// USAGE: /// Usage:
/// helptest [OPTIONS] /// helptest [OPTIONS]
/// ///
/// OPTIONS: /// Options:
/// --config Some help text describing the --config arg /// --config Some help text describing the --config arg
/// -h, --help Print help information /// -h, --help Print help information
/// -V, --version Print version information /// -V, --version Print version information
@ -1964,10 +1964,10 @@ impl Arg {
/// ```text /// ```text
/// prog /// prog
/// ///
/// USAGE: /// Usage:
/// prog [OPTIONS] /// prog [OPTIONS]
/// ///
/// OPTIONS: /// Options:
/// --config /// --config
/// The config file used by the myprog must be in JSON format /// The config file used by the myprog must be in JSON format
/// with only valid keys and may not contain other nonsense /// with only valid keys and may not contain other nonsense
@ -2030,10 +2030,10 @@ impl Arg {
/// ```text /// ```text
/// cust-ord /// cust-ord
/// ///
/// USAGE: /// Usage:
/// cust-ord [OPTIONS] /// cust-ord [OPTIONS]
/// ///
/// OPTIONS: /// Options:
/// -h, --help Print help information /// -h, --help Print help information
/// -V, --version Print version information /// -V, --version Print version information
/// -O, --other-option <b> I should be first! /// -O, --other-option <b> I should be first!
@ -2090,10 +2090,10 @@ impl Arg {
/// ```text /// ```text
/// nlh /// nlh
/// ///
/// USAGE: /// Usage:
/// nlh [OPTIONS] /// nlh [OPTIONS]
/// ///
/// OPTIONS: /// Options:
/// -h, --help Print help information /// -h, --help Print help information
/// -V, --version Print version information /// -V, --version Print version information
/// -o, --long-option-flag <value1> <value2> /// -o, --long-option-flag <value1> <value2>
@ -2136,10 +2136,10 @@ impl Arg {
/// ```text /// ```text
/// helptest /// helptest
/// ///
/// USAGE: /// Usage:
/// helptest [OPTIONS] /// helptest [OPTIONS]
/// ///
/// OPTIONS: /// Options:
/// -h, --help Print help information /// -h, --help Print help information
/// -V, --version Print version information /// -V, --version Print version information
/// ``` /// ```
@ -2310,10 +2310,10 @@ impl Arg {
/// ```text /// ```text
/// helptest /// helptest
/// ///
/// USAGE: /// Usage:
/// helptest [OPTIONS] /// helptest [OPTIONS]
/// ///
/// OPTIONS: /// Options:
/// -h, --help Print help information /// -h, --help Print help information
/// -V, --version Print version information /// -V, --version Print version information
/// ``` /// ```
@ -2337,10 +2337,10 @@ impl Arg {
/// ```text /// ```text
/// helptest /// helptest
/// ///
/// USAGE: /// Usage:
/// helptest [OPTIONS] /// helptest [OPTIONS]
/// ///
/// OPTIONS: /// Options:
/// --config Some help text describing the --config arg /// --config Some help text describing the --config arg
/// -h, --help Print help information /// -h, --help Print help information
/// -V, --version Print version information /// -V, --version Print version information
@ -2383,10 +2383,10 @@ impl Arg {
/// ```text /// ```text
/// helptest /// helptest
/// ///
/// USAGE: /// Usage:
/// helptest [OPTIONS] /// helptest [OPTIONS]
/// ///
/// OPTIONS: /// Options:
/// -h, --help Print help information /// -h, --help Print help information
/// -V, --version Print version information /// -V, --version Print version information
/// ``` /// ```
@ -2410,7 +2410,7 @@ impl Arg {
/// ```text /// ```text
/// helptest /// helptest
/// ///
/// USAGE: /// Usage:
/// helptest [OPTIONS] /// helptest [OPTIONS]
/// ///
/// OPTIONS: /// OPTIONS:

50
src/builder/command.rs
View file

@ -1660,7 +1660,7 @@ impl Command {
/// Does awesome things\n\ /// Does awesome things\n\
/// (C) me@mail.com\n\n\ /// (C) me@mail.com\n\n\
/// ///
/// USAGE: myapp <opts> <command>\n\n\ /// Usage: myapp <opts> <command>\n\n\
/// ///
/// Options:\n\ /// Options:\n\
/// -h, --help Display this message\n\ /// -h, --help Display this message\n\
@ -1769,7 +1769,7 @@ impl Command {
/// ///
/// This will be used for any arg that hasn't had [`Arg::help_heading`] called. /// This will be used for any arg that hasn't had [`Arg::help_heading`] called.
/// ///
/// This is useful if the default `OPTIONS` or `ARGS` headings are /// This is useful if the default `Options` or `Arguments` headings are
/// not specific enough for one's use case. /// not specific enough for one's use case.
/// ///
/// For subcommands, see [`Command::subcommand_help_heading`] /// For subcommands, see [`Command::subcommand_help_heading`]
@ -2585,16 +2585,16 @@ impl Command {
/// ```text /// ```text
/// cust-ord /// cust-ord
/// ///
/// USAGE: /// Usage:
/// cust-ord [OPTIONS] /// cust-ord [OPTIONS]
/// ///
/// OPTIONS: /// Subcommands:
/// -h, --help Print help information
/// -V, --version Print version information
///
/// SUBCOMMANDS:
/// beta I should be first! /// beta I should be first!
/// alpha Some help and text /// alpha Some help and text
///
/// Options:
/// -h, --help Print help information
/// -V, --version Print version information
/// ``` /// ```
#[inline] #[inline]
#[must_use] #[must_use]
@ -3053,16 +3053,16 @@ impl Command {
/// ```text /// ```text
/// myprog /// myprog
/// ///
/// USAGE: /// Usage:
/// myprog [SUBCOMMAND] /// myprog [SUBCOMMAND]
/// ///
/// OPTIONS: /// Subcommands:
/// -h, --help Print help information
/// -V, --version Print version information
///
/// SUBCOMMANDS:
/// help Print this message or the help of the given subcommand(s) /// help Print this message or the help of the given subcommand(s)
/// sub1 /// sub1
///
/// Options:
/// -h, --help Print help information
/// -V, --version Print version information
/// ``` /// ```
/// ///
/// but usage of `subcommand_value_name` /// but usage of `subcommand_value_name`
@ -3081,14 +3081,14 @@ impl Command {
/// ```text /// ```text
/// myprog /// myprog
/// ///
/// USAGE: /// Usage:
/// myprog [THING] /// myprog [THING]
/// ///
/// OPTIONS: /// Options:
/// -h, --help Print help information /// -h, --help Print help information
/// -V, --version Print version information /// -V, --version Print version information
/// ///
/// SUBCOMMANDS: /// Subcommands:
/// help Print this message or the help of the given subcommand(s) /// help Print this message or the help of the given subcommand(s)
/// sub1 /// sub1
/// ``` /// ```
@ -3100,7 +3100,7 @@ impl Command {
/// Sets the help heading used for subcommands when printing usage and help. /// Sets the help heading used for subcommands when printing usage and help.
/// ///
/// By default, this is "SUBCOMMANDS". /// By default, this is "Subcommands".
/// ///
/// See also [`Command::subcommand_value_name`] /// See also [`Command::subcommand_value_name`]
/// ///
@ -3119,14 +3119,14 @@ impl Command {
/// ```text /// ```text
/// myprog /// myprog
/// ///
/// USAGE: /// Usage:
/// myprog [SUBCOMMAND] /// myprog [SUBCOMMAND]
/// ///
/// OPTIONS: /// Options:
/// -h, --help Print help information /// -h, --help Print help information
/// -V, --version Print version information /// -V, --version Print version information
/// ///
/// SUBCOMMANDS: /// Subcommands:
/// help Print this message or the help of the given subcommand(s) /// help Print this message or the help of the given subcommand(s)
/// sub1 /// sub1
/// ``` /// ```
@ -3137,7 +3137,7 @@ impl Command {
/// # use clap::{Command, Arg}; /// # use clap::{Command, Arg};
/// Command::new("myprog") /// Command::new("myprog")
/// .subcommand(Command::new("sub1")) /// .subcommand(Command::new("sub1"))
/// .subcommand_help_heading("THINGS") /// .subcommand_help_heading("Things")
/// .print_help() /// .print_help()
/// # ; /// # ;
/// ``` /// ```
@ -3147,14 +3147,14 @@ impl Command {
/// ```text /// ```text
/// myprog /// myprog
/// ///
/// USAGE: /// Usage:
/// myprog [SUBCOMMAND] /// myprog [SUBCOMMAND]
/// ///
/// OPTIONS: /// Options:
/// -h, --help Print help information /// -h, --help Print help information
/// -V, --version Print version information /// -V, --version Print version information
/// ///
/// THINGS: /// Things:
/// help Print this message or the help of the given subcommand(s) /// help Print this message or the help of the given subcommand(s)
/// sub1 /// sub1
/// ``` /// ```