Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Links should throw warning/error on invalid character

Open
  • Is something wrong?
#765 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
42/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
markdown, powershell
Domain
documentation

Research direction

Start by reproducing the issue with New-CommandHelp using the Get-Test example, then trace how the .LINK value becomes HelpUri in the generated Get-Test.md and how import reads its metadata. Done means the generated help can be imported successfully and invalid link characters produce an appropriate warning or error.

Written by the indexing model from the issue text.

Description

Issue-Enhancement
Prerequisites
  • Write a descriptive title.
  • Make sure you are able to repro it on the latest version
  • Search the existing issues.
Steps to reproduce

Imagine the following function:

Function Get-Test {
    <#
    .SYNOPSIS
        Outputs a greeting message.

    .DESCRIPTION
        This function outputs a greeting message.
    
    .PARAMETER Name
        The name of the person to greet.
    
    .EXAMPLE
        Get-Test -Name "World"
    .NOTES
        Additional information about the function
    .LINK
        - https://example.com/documentation        
    #>
    [CmdletBinding()]
    param (
        [Parameter(Mandatory = $true)]
        [string]$Name
    )

    Write-Output "Hello, $Name! This is a test function."
}

Creating a CommandHelp object using New-CommandHelp is allowed. The export command also successfully exports the result. Trying to import the file, throws an error: No metadata found in Get-Test.md

The reason is because how the HelpUri is added to the metadata:

---
document type: cmdlet
external help file: Get-Test-Help.xml
HelpUri: >-
  https://example.com/documentation


  -
Locale: en-US
Module Name: ''
ms.date: 07/14/2025
PlatyPS schema version: 2024-05-01
title: Get-Test
---
Expected behavior
Able to import the command help after generation.
Actual behavior
An error occurs.
Error details
Environment data
Name                           Value
----                           -----
PSVersion                      7.5.2
PSEdition                      Core
GitCommitId                    7.5.2
OS                             Microsoft Windows 10.0.26100
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0
Version

1.0.0-preview5

Visuals

No response

Dominant language
C#
Stars
870
Forks
166
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from PowerShell/platyPS

All issues in PowerShell/platyPS

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.