Merge pull request #6101 from smoqadam/fix/value-enum-detailed-help

fix(ValueEnum): Detailed help for ValueEnum variant #6096

Author: epage

clap_derive/src/item.rs

@@ -901,13 +901,26 @@ impl Item {
             let (short_help, long_help) =
                 format_doc_comment(&lines, !self.verbatim_doc_comment, self.force_long_help);
             let short_name = format_ident!("{short_name}");
-            let short = Method::new(
-                short_name,
-                short_help
-                    .map(|h| quote!(#h))
-                    .unwrap_or_else(|| quote!(None)),
-            );
-            self.doc_comment.push(short);
+
+            let is_value_kind = matches!(self.kind.get(), Kind::Value);
+            let short_method = if is_value_kind && cfg!(feature = "unstable-v5") {
+                Method::new(
+                    short_name,
+                    long_help
+                        .clone()
+                        .or(short_help)
+                        .map(|h| quote!(#h))
+                        .unwrap_or_else(|| quote!(None)),
+                )
+            } else {
+                Method::new(
+                    short_name,
+                    short_help
+                        .map(|h| quote!(#h))
+                        .unwrap_or_else(|| quote!(None)),
+                )
+            };
+            self.doc_comment.push(short_method);
             if let Some(long_name) = long_name {
                 let long_name = format_ident!("{long_name}");
                 let long = Method::new(

tests/derive/doc_comments_help.rs

@@ -327,6 +327,42 @@ Options:
 "#]].raw());
 }
 
+#[cfg(feature = "unstable-v5")]
+#[test]
+fn value_enum_multiline_doc_comment() {
+    #[derive(Parser, Debug)]
+    struct Command {
+        x: LoremIpsum,
+    }
+
+    #[derive(ValueEnum, Clone, PartialEq, Debug)]
+    enum LoremIpsum {
+        /// Doc comment summary
+        ///
+        /// The doc comment body is not ignored
+        Bar,
+    }
+
+    let help = utils::get_long_help::<Command>();
+
+    assert_data_eq!(help, str![[r#"
+Usage: clap <X>
+
+Arguments:
+  <X>
+          Possible values:
+          - bar: Doc comment summary
+            
+            The doc comment body is not ignored
+
+Options:
+  -h, --help
+          Print help (see a summary with '-h')
+
+"#]].raw());
+}
+
+#[cfg(not(feature = "unstable-v5"))]
 #[test]
 fn value_enum_multiline_doc_comment() {
     #[derive(Parser, Debug)]