Skip to content

Commit 5144ac9

Browse files
fix: split .INPUTS/.OUTPUTS type and description onto separate lines
PlatyPS renders each .INPUTS/.OUTPUTS line as a ### heading. The canonical PowerShell format puts the type name alone on its first line and the description as body text on the next line. This prevents MD026 (no-trailing-punctuation) violations in generated docs. Correct format: .OUTPUTS System.String A greeting string for the given name. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent 7b59e8d commit 5144ac9

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

src/functions/public/Get-PSModuleTest.ps1

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,12 @@ function Get-PSModuleTest {
1313
Hello, World!
1414
1515
.INPUTS
16-
None. You can't pipe objects to Get-PSModuleTest.
16+
None
17+
You can't pipe objects to Get-PSModuleTest.
1718
1819
.OUTPUTS
19-
System.String. A greeting string for the given name.
20+
System.String
21+
A greeting string for the given name.
2022
#>
2123
[OutputType([string])]
2224
[CmdletBinding()]

0 commit comments

Comments
 (0)