platyPS
platyPS copied to clipboard
Tick (continuation) in example section breaks rendering
Prerequisites
- [X] Write a descriptive title.
- [X] Make sure you are able to repro it on the latest released version
- [X] Search the existing issues.
Steps to reproduce
I am experiencing problem with generated MD when PS file contains tick (continuation) in .EXAMPLE section.
Function WillBreakMarkwon
{
<#
.SYNOPSIS
Synopsis
.DESCRIPTION
Description
.PARAMETER Param1
Description of 1st param
.OUTPUTS
Nothing
.EXAMPLE
$x = Add-LpWAddress `
-Param1 1
#>
[CmdletBinding(SupportsShouldProcess = $True)]
param
(
[Parameter(Mandatory = $true,ValueFromPipeline = $true)]
$Param1
)
process
{
}
}
Expected behavior
### EXAMPLE 1
ticks
$x = Add-LpWAddress `
-Param1 1
ticks
Actual behavior
### EXAMPLE 1
ticks
$x = Add-LpWAddress `
ticks
-Param1 1
Error details
No response
Environment data
ModuleType Version Name ExportedCommands
---------- ------- ---- ----------------
Script 0.14.2 platyPS {New-MarkdownHelp, Get-MarkdownMetadata, New-ExternalHelp, New-YamlHelp...}
Name Value
---- -----
PSVersion 5.1.19041.1645
PSEdition Desktop
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0...}
BuildVersion 10.0.19041.1645
CLRVersion 4.0.30319.42000
WSManStackVersion 3.0
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
Visuals

@kfrajtak thank you for reporting this - I will investigate and review the PR.
No repro in v0.14.2. But broken in Microsoft.PowerShell.PlatyPS, which is a duplicate of #487