Get the synopsis more correctly from the help object. Fix #328

vors · vors · commit 8499a2e41081 · 2018-06-06T00:06:05.000-07:00
diff --git a/src/platyPS/platyPS.psm1 b/src/platyPS/platyPS.psm1
@@ -2680,7 +2680,13 @@ function ConvertPsObjectsToMamlModel
     }
     else
     {
-        $MamlCommandObject.Synopsis = New-Object -TypeName Markdown.MAML.Model.Markdown.SectionBody ($Help.Synopsis.Trim())
+        $MamlCommandObject.Synopsis = New-Object -TypeName Markdown.MAML.Model.Markdown.SectionBody (
+            # $Help.Synopsis only contains the first paragraph
+            # https://github.com/PowerShell/platyPS/issues/328
+            $Help.details.description |
+            DescriptionToPara |
+            AddLineBreaksForParagraphs
+        )
     }
 
     #Get Description

Original file line number	Diff line number	Diff line change
`@@ -2680,7 +2680,13 @@ function ConvertPsObjectsToMamlModel`
`2680`	`2680`	`}`
`2681`	`2681`	`else`
`2682`	`2682`	`{`
`2683`		`- $MamlCommandObject.Synopsis = New-Object -TypeName Markdown.MAML.Model.Markdown.SectionBody ($Help.Synopsis.Trim())`
	`2683`	`+ $MamlCommandObject.Synopsis = New-Object -TypeName Markdown.MAML.Model.Markdown.SectionBody (`
	`2684`	`+ # $Help.Synopsis only contains the first paragraph`
	`2685`	`+ # https://github.com/PowerShell/platyPS/issues/328`
	`2686`	`+ $Help.details.description \|`
	`2687`	`+ DescriptionToPara \|`
	`2688`	`+ AddLineBreaksForParagraphs`
	`2689`	`+ )`
`2684`	`2690`	`}`
`2685`	`2691`
`2686`	`2692`	`#Get Description`