Skip to content

New-MarkdownCommandHelp Omits Description for -Confirm and -WhatIf #735

Closed
@RobertKlohr

Description

@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 for commands that support ShouldProcess the output contain the Confirm and Whatif parameters in the markdown but the description is the placeholder.

$newMarkdownCommandHelpSplat = @{
    ModuleInfo = Get-Module ModuleWithShouldProcess
    OutputFolder = '.'
    HelpVersion = '1.0.0.0'
    WithModulePage = $true
}
New-MarkdownCommandHelp @newMarkdownCommandHelpSplat

Expected behavior

### -Confirm

Prompts you for confirmation before running the cmdlet.

and

### -WhatIf

Shows what would happen if the cmdlet runs.
The cmdlet is not run.

Actual behavior

### -Confirm

{{ Fill Confirm Description }}

and

### -WhatIf

{{ Fill WhatIf Description }}

Error details

No error message.

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

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions