New-MarkdownCommandHelp Outputs Bare URL

[RobertKlohr]

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

When using New-MarkdownCommandHelp the markdown output for a URL is missing the angle brackets.

Expected behavior

[](https://www.example.com)

or

<https://www.example.com>

Actual behavior

https://www.example.com

Error details

MD034 no-bare-urls - Bare URL used

Environment data

Get-Module Microsoft.PowerShell.PlatyPS -ListAvailable

ModuleType Version    PreRelease Name                                PSEdition ExportedCommands
---------- -------    ---------- ----                                --------- ----------------
Script     1.0.0      preview3   Microsoft.PowerShell.PlatyPS        Desk      {New-MarkdownCommandHelp, Import-MamlHelp, Import-Mar… 

$PSVersionTable

Name                           Value
----                           -----
PSVersion                      7.4.7
PSEdition                      Core
GitCommitId                    7.4.7
OS                             Microsoft Windows 10.0.22631
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]

@RobertKlohr Can you provide a source example that reproduces this?

[RobertKlohr]

I added a URL to the description in the sample module.

There is a second URL that was already in the sample module as output, but I would ignore that one for this issue as that URL should be wrapped in a code fence as part of the .EXAMPLE entry and would not trigger if issue #737 resolved.

I updated the issue description to be more specific as there are at least two different ways to include a URL in markdown i.e., with angle brackets or using the "text" format. As the second way is more flexible and is how the URL in "Related Links" is built it makes sense to use that format.

ExampleModule.zip

[sdwheeler]

PlatyPS doesn't parse the comment-based help. It gets it from Get-Help. It doesn't and will never try to analyze the help content to change the markup. If you want the URL marked up you need to write it that way in the comments. For example:

.DESCRIPTION
    Returns information about a app or set of Apps.

    This module creates a wrapper for the fictitious API located at <https://api.example.com/>