PowerShell / platyPS

Write PowerShell External Help in Markdown
MIT License
765 stars 149 forks source link

CommonParameters should not be overwritten when newlines are introduced #598

Closed chscott closed 10 months ago

chscott commented 1 year ago

Prerequisites

Steps to reproduce

I'm using markdownlint to lint my docs, and it doesn't like the CommonParameters section's line length or the lack of a newline between the section heading and the content.

image

I satisfy the linter by adding newlines.

image

When I run Update-MarkdownHelp, CommonParameters is restored to the version shown in the first screenshot.

Expected behavior

Running `Update-MarkdownHelp` should leave the section alone.

Actual behavior

Running `Update-MarkdownHelp` reverts my changes.

Error details

N/A

Environment data

ModuleType Version    PreRelease Name                                PSEdition ExportedCommands
---------- -------    ---------- ----                                --------- ----------------
Script     0.14.2                platyPS                             Desk      {New-MarkdownHelp, Get-MarkdownMetadata, New-ExternalHelp, Ne… 

Name                           Value
----                           -----
PSVersion                      7.3.4
PSEdition                      Core
GitCommitId                    7.3.4
OS                             Microsoft Windows 10.0.22621
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0


### Visuals

_No response_
sdwheeler commented 10 months ago

This is already on the roadmap to be fixed. Duplicate of #430