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

Missing parameters implementations for the Update-MarkdownModuleFile command

Open
  • Is something wrong?
#867 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
Half a day
Newbie friendliness
68/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
csharp
Domain
cli, documentation

Research direction

Start with the UpdateMarkdownModuleFileCommand class, where the issue says the HelpInfoUri and HelpVersion parameters exist but are never used. Compare it with New-MarkdownModuleFile, which already writes these values into the module front matter, and trace how the update path reads the manifest. Done when running Update-MarkdownModuleFile on a changed manifest rewrites Help Version and HelpInfoUri in the existing Test.md.

Written by the indexing model from the issue text.

Description

Steps to reproduce

The Update-MarkdownModuleFile command does not honor the HelpInfoUri and HelpVersion parameters (the properties are available in the UpdateMarkdownModuleFileCommand class, but not implemented).

Run New-MarkdownModuleFile with this module manifest snippet for Test.psd1 to create the module Markdown file:

Use ModuleVersion for the HelpVersion parameter.

@{
    RootModule        = 'Test.psm1'
    ModuleVersion     = '1.1.1'
    HelpInfoURI       = 'https://my-fancy-website/Test'
    ...
}

Then run Update-MarkdownModuleFile with an updated manifest snippet:

@{
    RootModule        = 'Test.psm1'
    ModuleVersion     = '2.0.0'
    HelpInfoURI       = 'https://someone-elses-fancy-website/Test'
    ...
}
Expected behavior

When created, front matter for module's Markdown Test.md is as follows:

---
document type: module
Help Version: 1.1.1
HelpInfoUri: https://my-fancy-website/Test
...
---

After running the update command with the updated manifest, the front matter should be as follows:

---
document type: module
Help Version: 2.0.0
HelpInfoUri: https://someone-elses-fancy-website/Test
...
---
Actual behavior

After running the update command, the front matter remains unchanged:

---
document type: module
Help Version: 1.1.1
HelpInfoUri: https://my-fancy-website/Test
...
---
Error details
Environment data
PSVersion                      7.6.6
PSEdition                      Core
GitCommitId                    7.6.6
OS                             Microsoft Windows 10.0.22631
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.4
SerializationVersion           1.1.0.1
WSManStackVersion              3.0
Version

1.0.3

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.