PowerShell / PowerShell/platyPS
Merge-MarkdownHelp munges multiple syntax blocks together
Open
Nobody has claimed this yet.
Area-MergeMarkdown
- Dominant language
- C#
- Stars
- 871
- Forks
- 166
- Avg merge
- 21h 17m
- Merged PRs (30d)
- 1
Description
Steps to reproduce
- Take existing markdown files not created by platyPS for Exchange 2010, 2013, and 2016 (see attached).
- Run Merge-MarkdownHelp -ExplicitApplicableIfAll -Path "InPath1","InPath2","InPath3" -OutputPath "OutPath"
Expected behavior
Existing syntax blocks are preserved/compared using merge markers
Actual behavior
Existing syntax blocks are combined into one big block containing mutually exclusive parameters (see attached)
Environment data
v0.9.0
Add-ADPermission2016.txt
Add-ADPermissionMerged.txt
Add-ADPermission2010.txt
Add-ADPermission2013.txt
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 with the Merge-MarkdownHelp command and reproduce the issue using the Exchange 2010, 2013, and 2016 Markdown files linked in the report. Compare the merged output with the attached Add-ADPermission files; done means mutually exclusive syntax blocks remain separate and are compared using merge markers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, powershell
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100