PowerShell / PowerShell/platyPS
Update-MarkdownCommandHelp duplicates Parameter content if HelpMessage is specified
Open
Nobody has claimed this yet.
Needs-Triage
- Dominant language
- C#
- Stars
- 871
- Forks
- 166
- Avg merge
- 21h 17m
- Merged PRs (30d)
- 1
Description
Prerequisites
- Write a descriptive title.
- Make sure you are able to repro it on the latest version
- Search the existing issues.
Steps to reproduce
Expected behavior
If the first line exactly matches the HelpMessage, preserve everything below (to enable the addition of additional context to the MD file)
If the first line does not match the helpmessage, only update the first line. Maybe have a `-ReplaceParameterHelp` option to force a direct replacement if the helpmessage is updated.
Also the helpmessage part of the YAML isn't populated correctly
Actual behavior
See Above
Error details
N/A
Environment data
Name Value
---- -----
PSVersion 7.6.1
PSEdition Core
GitCommitId 7.6.1
OS Microsoft Windows 10.0.26200
Platform Win32NT
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion 2.4
SerializationVersion 1.1.0.1
WSManStackVersion 3.0
Version
1.01
Visuals
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the duplication with Update-MarkdownCommandHelp using a command whose HelpMessage is specified, then inspect the generated Markdown and YAML. Compare cases where the first line matches or differs from HelpMessage; done means additional Markdown context is preserved correctly, replacement is consistent with the requested behavior, and the YAML HelpMessage is populated correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, powershell
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100