Running Update-MarkdownHelp with no changes is adding CommonParameters

[rkeithhill]

BTW very well could be a problem with the initial new-markdownhelp not adding the common parameter info in the first place.

Steps to reproduce

Generate markdown with new-markdownhelp on advanced function.
Fill in placeholders.
Commit that
With no changes to the function run update-markdownhelp.

Expected behavior

No difference.

Actual behavior

[CommonParameters] was added to the syntax section.

Also curious that update removed a blank line.

Environment data

v0.7.2

[rkeithhill]

Also, I'm not using -AlphabeticParamsOrder yet Update-MarkdownHelp wants to put Confirm first rather than at the end before WhatIf.

[BernieWhite]

@vors @rkeithhill So the desired behaviour is to supress CommonParameters if it doesn't exist in an existing markdown document?

[rkeithhill]

My primary complaint is that after you run New-MarkdownHelp, running Update-MarkdownHelp should not cause any changes to the markdown file if there have been no changes to the function sig. OTOH if I changed the function to an advanced function then the addition of common parameters by Update-MarkdownHelp would make sense.

[BernieWhite]

@rkeithhill Thanks. That helped and I see the issue. Currently New-MarkdownHelp will never generate CommonParameters for functions regardless of [CmdletBinding()] usage.

Update-MarkdownHelp appears to be working as expected. Only adding CommonParameters when required.

[rkeithhill]

Ah, so it's a New-MarkdownHelp issue then?

[BernieWhite]

Yes, the markdown generated by New-MarkdownHelp is currently incomplete concerning CommonParameters and corrected by Update-MarkdownHelp.

@rkeithhill Will fixing New-MarkdownHelp address this issue?

Re: the blank line being removed in outputs sections see #319.