PowerShell / PowerShell/platyPS
`New-MarkdownCommandHelp` & `Export-MamlCommandHelp` commands create a parent folder with module name
Nobody has claimed this yet.
- 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
I have some markdown files which I create in my ./docs/en-US folder using New-MarkdownCommandHelp.
When I run New-MarkdownCommandHelp it creates another parent folder with the module name inside like ./docs/en-US/<ModuleName>
Same happens with Export-MamlCommandHelp.
Workaround is to flatten the directory structure, but this is extra work. Is there another parameter to avoid this? I don't think any command should be creating parent folders and leave that to the user to decide.
Expected behavior
To output directly into the directory, I specify and create no extra parent folders.
Actual behavior
Creates parent directory with module name.
Error details
Environment data
Name Value
---- -----
PSVersion 7.5.4
PSEdition Core
GitCommitId 7.5.4
OS Microsoft Windows 10.0.26100
Platform Win32NT
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
WSManStackVersion 3.0
Version
1.0.1
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
Reproduce the behavior with New-MarkdownCommandHelp and Export-MamlCommandHelp using a directory such as ./docs/en-US, then trace how each command chooses its output path. Confirm that output can be written directly to the specified directory without creating a module-named parent folder, and add or update coverage for both commands if the repository provides it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- cli, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100