-
Notifications
You must be signed in to change notification settings - Fork 156
Closed
Labels
Area-UpdateMarkdownIssue deals with the Update-* cmdletsIssue deals with the Update-* cmdletsResolution-Won't FixThe issue won't be fixed, possibly due to compatibility reason.The issue won't be fixed, possibly due to compatibility reason.
Milestone
Description
Update-MarkdownHelp does not update
Steps to reproduce
Create a function in a Module, do NOT describe a parameter.
Import the module, run New-MarkdownHelp -Module
The description for uncommented Parameter is - per design - replaced with double curly brackets {{...}}
Describe the parameter, remove the module, import the module again
Verify with Get-Help
that the description is visible
Run Update-MarkdownHelp
to update all documentation
Expected behavior
Curly brackets are replaced with description text for the parameter
Actual behavior
Section is not replaced
Further analysis
Section is also not replaced if curly brackets are removed and .md file saved first.
Using the Force does not help
Workaround
Remove .MD file and run New-Markdownhelp again
Environment data
PlatyPS version v.0.14.0
Name Value
---- -----
PSVersion 5.1.19041.610
PSEdition Desktop
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0...}
BuildVersion 10.0.19041.610
CLRVersion 4.0.30319.42000
WSManStackVersion 3.0
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
and
Name Value
---- -----
PSVersion 7.2.0-preview.2
PSEdition Core
GitCommitId 7.2.0-preview.2
OS Microsoft Windows 10.0.19042
Platform Win32NT
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
WSManStackVersion 3.0
Metadata
Metadata
Assignees
Labels
Area-UpdateMarkdownIssue deals with the Update-* cmdletsIssue deals with the Update-* cmdletsResolution-Won't FixThe issue won't be fixed, possibly due to compatibility reason.The issue won't be fixed, possibly due to compatibility reason.
Type
Projects
Milestone
Relationships
Development
Select code repository
Activity
smholvoet commentedon Dec 8, 2021
Experiencing the same behavior:
Update-MarkdownHelp
doesn't update existing Markdown files which have been generated byNew-MarkdownHelp
, even though the cmdlet itself has an updated synopsis, description, etc...Output after running the command:
platyPS version:
$PSVerionTable:
ChefkeGremmen commentedon Mar 12, 2024
Yup, very annoying issue. Let me know if I can test-drive any potential fixes.
adityapatwardhan commentedon Jun 24, 2025
@sdwheeler please re-test
sdwheeler commentedon Jun 24, 2025
This is too focused on v0.14.2. Closing this issue. Creating a new issue for Microsoft.PowerShell.PlatyPS.