Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tick (continuation) in example section breaks rendering #566

Closed
3 tasks done
kfrajtak opened this issue May 10, 2022 · 2 comments
Closed
3 tasks done

Tick (continuation) in example section breaks rendering #566

kfrajtak opened this issue May 10, 2022 · 2 comments
Labels
Area-Comment-Based-Help Issue deals with conversion of comment-based help platyps-0.14.2 Resolution-Duplicate The issue is a duplicate.

Comments

@kfrajtak
Copy link

kfrajtak commented May 10, 2022

Prerequisites

  • Write a descriptive title.
  • Make sure you are able to repro it on the latest released version
  • 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

```
$x = Add-LpWAddress `
  -Param1 1

```

Actual behavior

### EXAMPLE 1

```
$x = Add-LpWAddress `
```

-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

image

@kfrajtak kfrajtak added the Needs-Triage The issue is new and needs to be triaged by a work group. label May 10, 2022
@sdwheeler sdwheeler removed the Needs-Triage The issue is new and needs to be triaged by a work group. label May 23, 2022
@theJasonHelmick theJasonHelmick added the Area-Comment-Based-Help Issue deals with conversion of comment-based help label May 23, 2022
@theJasonHelmick
Copy link
Collaborator

@kfrajtak thank you for reporting this - I will investigate and review the PR.

@sdwheeler
Copy link
Collaborator

No repro in v0.14.2. But broken in Microsoft.PowerShell.PlatyPS, which is a duplicate of #487

@sdwheeler sdwheeler added the Resolution-Duplicate The issue is a duplicate. label May 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-Comment-Based-Help Issue deals with conversion of comment-based help platyps-0.14.2 Resolution-Duplicate The issue is a duplicate.
Projects
None yet
Development

No branches or pull requests

3 participants