Skip to content

Update-MarkdownHelp does not update placeholders "{{ }}" once Parameters have been described in the Function  #494

Open
@DEberhardt

Description

@DEberhardt

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

Labels

Area-UpdateMarkdownIssue deals with the Update-* cmdletsBlockedTag - blocked on something external to this repoNeeds-Retest

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions