Improve checking of module markdown files in GetMarkdownFilesFromPath #456
Conversation
|
@bmsimons Can you add tests for this? |
adityapatwardhan
requested review from
adityapatwardhan and
vors
and removed request for
vors
| [https://test.com](https://test.com) | ||
| '@ |
There was a problem hiding this comment.
All the "setup" steps in this It should be moved to BeforeAll, especially because the files are used in another It.
vors
left a comment
vors
left a comment
There was a problem hiding this comment.
Thank you for taking a stub at it!
Please include some text explanation of the problem that tries to solve and how it's solved in the PR main body. At the moment it just reference the bug number. It requires additional hopes (and web browser) to figure out the context. After few years, it would be much harder to do - it's good idea to include the minimal context in the PR body, so when it's merged it will be preserved in git history directly.
| $MarkdownFilesFiltered = $MarkdownFiles | ||
| } Else { | ||
| ForEach ($File in $MarkdownFiles) { | ||
| $Matches = [regex]::Match((Get-Content $File.FullName -Raw), "# $($File.BaseName) Module").Captures.Groups |
There was a problem hiding this comment.
I don't understand that line, can you add a comment that explains the intention here?
| } | ||
| } | ||
|
|
||
| return $MarkdownFiles |
There was a problem hiding this comment.
If we are going this route of the more intelligent heuristic, we should remove the old dash-based heuristic.
|
|
||
| It "Checks if external help files are generated correctly with dash in module markdown file" { | ||
| Rename-Item -Path (Join-Path $TestDrive "\docs\TestModule.md") -NewName "Test-Module.md" | ||
| (Get-Content "$TestDrive\docs\Test-Module.md") -replace "TestModule", "Test-Module" | Set-Content "$TestDrive\docs\Test-Module.md" |
There was a problem hiding this comment.
Is it needed, why we cannot create it directly?
|
Thank you for your contribution. We are no longer maintaining the v0.14 version of platyPS. If you’re interested in continuing to help, we’d love your support on the release version of Microsoft.PowerShell.PlatyPS v1.0.0. |
theJasonHelmick
added
the
Resolution-Won't Fix
5 participants
Fixes #447