Merge #2058

2058: Add blank line between items in long help r=pksunkara a=mkantor



Co-authored-by: Matt Kantor <the.matt.kantor@gmail.com>

src/build/arg/mod.rs

@@ -599,24 +599,24 @@ impl<'help> Arg<'help> {
     /// The above example displays
     ///
     /// ```text
-    /// helptest
+    /// prog
     ///
     /// USAGE:
-    ///    helptest [FLAGS]
+    ///     prog [FLAGS]
     ///
     /// FLAGS:
-    ///    --config
-    ///         The config file used by the myprog must be in JSON format
-    ///         with only valid keys and may not contain other nonsense
-    ///         that cannot be read by this program. Obviously I'm going on
-    ///         and on, so I'll stop now.
+    ///         --config
+    ///             The config file used by the myprog must be in JSON format
+    ///             with only valid keys and may not contain other nonsense
+    ///             that cannot be read by this program. Obviously I'm going on
+    ///             and on, so I'll stop now.
     ///
-    /// -h, --help
-    ///         Prints help information
-    ///
-    /// -V, --version
-    ///         Prints version information
+    ///     -h, --help
+    ///             Prints help information
     ///
+    ///     -V, --version
+    ///             Prints version information
+    /// ```
     /// [`Arg::about`]: ./struct.Arg.html#method.about
     #[inline]
     pub fn long_about(mut self, h: &'help str) -> Self {

src/output/help.rs

@@ -454,7 +454,7 @@ impl<'help, 'app, 'parser, 'writer> Help<'help, 'app, 'parser, 'writer> {
             }
             self.none(part)?;
         }
-        if !prevent_nlh && !help.contains('\n') && (nlh || self.force_next_line) {
+        if !prevent_nlh && (nlh || self.force_next_line) {
             self.none("\n")?;
         }
         Ok(())

tests/help.rs

@@ -269,6 +269,7 @@ FLAGS:
     -h, --help
             Prints help
             information
+
     -V, --version
             Prints
             version
@@ -354,6 +355,24 @@ FLAGS:
             Prints version
             information";
 
+static ISSUE_1642: &str = "prog 
+
+USAGE:
+    prog [FLAGS]
+
+FLAGS:
+        --config     
+            The config file used by the myprog must be in JSON format
+            with only valid keys and may not contain other nonsense
+            that cannot be read by this program. Obviously I'm going on
+            and on, so I'll stop now.
+
+    -h, --help       
+            Prints help information
+
+    -V, --version    
+            Prints version information";
+
 static CUSTOM_VERSION_AND_HELP: &str = "customize 0.1
 Nobody <odysseus@example.com>
 You can customize the version and help text
@@ -1766,3 +1785,14 @@ fn help_required_and_no_args() {
         .setting(AppSettings::HelpRequired)
         .get_matches();
 }
+
+#[test]
+fn issue_1642_long_help_spacing() {
+    let app = App::new("prog").arg(Arg::new("cfg").long("config").long_about(
+        "The config file used by the myprog must be in JSON format
+with only valid keys and may not contain other nonsense
+that cannot be read by this program. Obviously I'm going on
+and on, so I'll stop now.",
+    ));
+    assert!(utils::compare_output(app, "prog --help", ISSUE_1642, false));
+}