Join adjacent lines in descriptions from #[doc]s

schemars/tests/docs.rs

@@ -19,13 +19,14 @@ pub struct MyStruct {
 }
 
 /// # A Unit
+///
 #[derive(Debug, JsonSchema)]
 pub struct MyUnitStruct;
 
 #[doc = " # This is the enum's title "]
-#[doc = " This is..."]
+#[doc = " This is "]
 #[derive(Debug, JsonSchema)]
-#[doc = "...the enum's description. "]
+#[doc = " the enum's description."]
 pub enum MyEnum {
     UndocumentedUnit,
     /// This comment is not included in the generated schema :(
@@ -37,7 +38,15 @@ pub enum MyEnum {
         ///
         /// This field is a nullable string.
         ///
-        /// This is another line!
+        /// This
+        ///is
+        ///   the second
+        ///  line!
+        ///
+        ///
+        ///
+        ///
+        /// And this is the third!
         my_nullable_string: Option<String>,
     },
 }

schemars_derive/src/doc_attrs.rs

@@ -14,23 +14,25 @@ pub fn get_title_and_desc_from_docs(attrs: &[Attribute]) -> (Option<String>, Opt
             .trim_start_matches('#')
             .trim()
             .to_owned();
-        let maybe_desc = split.next().map(|s| s.trim().to_owned());
+        let maybe_desc = split.next().and_then(get_description);
         (none_if_empty(title), maybe_desc)
     } else {
-        (None, none_if_empty(docs))
+        (None, get_description(&docs))
     }
 }
 
-fn none_if_empty(s: String) -> Option<String> {
+fn get_description(docs: &str) -> Option<String> {
-    if s.is_empty() {
+    let desc = docs
-        None
+        .trim()
-    } else {
+        .split("\n\n")
-        Some(s)
+        .filter_map(|line| none_if_empty(line.trim().replace('\n', " ")))
-    }
+        .collect::<Vec<_>>()
+        .join("\n\n");
+    none_if_empty(desc)
 }
 
 fn get_docs(attrs: &[Attribute]) -> Option<String> {
-    let doc_attrs = attrs
+    let docs = attrs
         .iter()
         .filter_map(|attr| {
             if !attr.path.is_ident("doc") {
@@ -44,20 +46,20 @@ fn get_docs(attrs: &[Attribute]) -> Option<String> {
 
             None
         })
-        .collect::<Vec<_>>();
+        .collect::<Vec<_>>()
-
-    if doc_attrs.is_empty() {
-        return None;
-    }
-
-    let mut docs = doc_attrs
         .iter()
         .flat_map(|a| a.split('\n'))
         .map(str::trim)
         .skip_while(|s| *s == "")
         .collect::<Vec<_>>()
         .join("\n");
-
+    none_if_empty(docs)
-    docs.truncate(docs.trim_end().len());
+}
-    Some(docs)
+
+fn none_if_empty(s: String) -> Option<String> {
+    if s.is_empty() {
+        None
+    } else {
+        Some(s)
+    }
 }