mirror of
https://github.com/PowerShell/PowerShell
synced 2026-06-08 12:12:50 +00:00
Fix NOTES section formatting in comment-based help (#26512)
This commit is contained in:
@@ -0,0 +1,27 @@
|
||||
# Copyright (c) Microsoft Corporation.
|
||||
# Licensed under the MIT License.
|
||||
|
||||
Describe 'Comment-based help NOTES section formatting' -Tags "CI", "Feature" {
|
||||
It 'NOTES section should have single blank line after header and 4-space indentation' {
|
||||
$helpText = Get-Help Remove-PSSession -Full | Out-String
|
||||
$lines = $helpText -split "`r?`n"
|
||||
|
||||
# Find NOTES section
|
||||
$notesIndex = -1
|
||||
for ($i = 0; $i -lt $lines.Count; $i++) {
|
||||
if ($lines[$i] -match '^NOTES\s*$') {
|
||||
$notesIndex = $i
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
$notesIndex | Should -BeGreaterThan -1 -Because "NOTES section should exist"
|
||||
|
||||
# The line after NOTES header should be blank
|
||||
$lines[$notesIndex + 1] | Should -Match '^\s*$' -Because "There should be a blank line after NOTES header"
|
||||
|
||||
# The second line after NOTES header should have content with 4-space indentation
|
||||
$contentLine = $lines[$notesIndex + 2]
|
||||
$contentLine | Should -Match '^[ ]{4}\S' -Because "Content should have exactly 4-space indentation"
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user