fix(help):Be dense on short next line help

If short help is too long for the terminal, clap will automatically switch to next line help. As part of next line help for longs, we add a blank line between args. This helps make the args clearer when dealing with multiple paragraphs. However, its not as much needed for short and subcommands (always short), so now short matches subcommands. This was inspired by #3300 and a part of #4132
clap-rs · Sep 7, 2022 · bc04b49 · bc04b49
1 parent 69dd145
commit bc04b49
Show file tree

Hide file tree

Showing 4 changed files with 1 addition and 16 deletions.
diff --git a/examples/tutorial_builder/02_app_settings.md b/examples/tutorial_builder/02_app_settings.md
@@ -7,13 +7,10 @@ Usage: 02_app_settings[EXE] --two <VALUE> --one <VALUE>
 Options:
         --two <VALUE>
             
-
         --one <VALUE>
             
-
     -h, --help
             Print help information
-
     -V, --version
             Print version information
 

diff --git a/examples/tutorial_derive/02_app_settings.md b/examples/tutorial_derive/02_app_settings.md
@@ -7,13 +7,10 @@ Usage: 02_app_settings_derive[EXE] --two <TWO> --one <ONE>
 Options:
         --two <TWO>
             
-
         --one <ONE>
             
-
     -h, --help
             Print help information
-
     -V, --version
             Print version information
 

diff --git a/src/output/help.rs b/src/output/help.rs
@@ -438,7 +438,7 @@ impl<'cmd, 'writer> Help<'cmd, 'writer> {
         for (i, (_, arg)) in ord_v.iter().enumerate() {
             if i != 0 {
                 self.none("\n");
-                if next_line_help {
+                if next_line_help && self.use_long {
                     self.none("\n");
                 }
             }

diff --git a/tests/builder/help.rs b/tests/builder/help.rs
@@ -355,17 +355,13 @@ Options:
     -a, --all
             Also do versioning for private crates (will not be
             published)
-
         --exact
             Specify inter dependency version numbers exactly with
             `=`
-
         --no-git-commit
             Do not commit version changes
-
         --no-git-push
             Do not push generated commit and tags to git remote
-
     -h, --help
             Print help information
 ";
@@ -694,10 +690,8 @@ Options:
             les marchés d\'exportation. Le café est
             souvent une contribution majeure aux
             exportations des régions productrices.
-
     -h, --help
             Print help information
-
     -V, --version
             Print version information
 ";
@@ -743,7 +737,6 @@ Options:
     -h, --help
             Print help
             information
-
     -V, --version
             Print
             version
@@ -816,7 +809,6 @@ Options:
             that require an
             emulator. See
             https://github.com/rust-lang/rustup/wiki/Non-host-toolchains
-
     -h, --help
             Print help
             information
@@ -1168,7 +1160,6 @@ Usage: ctest
 Options:
     -h, --help
             Print help information
-
     -V, --version
             Print version
             information