Use parameter HelpMessage (if present) as a description for the parameter

[dotps1]

I think each parameter should have a description block. And, if the HelpMessage Parameter Attribute is used, then it should default to that value.

[vors]

Ha, it doesn't work?

[dotps1]

Not with the latest version from the gallery. Yeah i was going to say i thought i had added that functionality. must have gotten lost in the changes.

[dotps1]

there is a blank line where it looks like it would go:

### -Comment
```yaml
Type: String
Parameter Sets: (All)
Aliases: 
                       <------ looks like description field here.
Required: True
Position: 1
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
\```

[vors]

Hm, so the blank line there to distinguish between two blocks of metadata (it's not mandatory, we just thought it will look better).

Description should be like

### -Comment
                <------ looks like description field here.
```yaml
Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 1
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

Schema for references

[dotps1]

gotcha, yeah not getting that. you can grab my latest version PSGist form the gallery, all the parameters in each cmdlet have the HelpMessage Attribute, if you need something to test with. then i did:

New-MarkdownHelp -Module PSGist -OutputFolder C:\users\me\desktop\markdown

[jongeller]

Looking at the code, we do seem to cover this scenario. Going to work on the repro using PSGist.

[jongeller]

Found this:
In PlatyPS.psm1 the function call to AddLineBreaksForParagraphs
https://github.com/PowerShell/platyPS/blob/master/src/platyPS/platyPS.psm1#L1381
The string for HelpMessage does not get passed in.
@vors I've been looking at it for a while, and the only fix I found breaks a bunch of other areas that leverage that function. Could you see if you see why the text is not passing in?

[vors]

Probably because in the caller (https://github.com/PowerShell/platyPS/blob/master/src/platyPS/platyPS.psm1#L1561) maml-based help and comment-based help genereted different objects (i.e. there is no text property or something).

This bug is closely related to #132 (differences between maml-originated help object and comment-based help one)

[jongeller]

So, what do? Do you want to take this one?

[vors]

ok