Skip to content

Fix NOTES section formatting in comment-based help #26512

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
iSazonov merged 5 commits into from
Dec 3, 2025
Merged

Fix NOTES section formatting in comment-based help #26512

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1b328f4
Fix NOTES section formatting in comment-based help (#26102)
yotsuda Nov 22, 2025
e80b02d
Add missing newline at end of test file
yotsuda Nov 22, 2025
beddbc4
Update test/powershell/Language/Scripting/ScriptHelp.NotesFormatting.…
yotsuda Nov 24, 2025
3c25e01
Remove unused BeforeAll block from test file
yotsuda Nov 24, 2025
35b51dc
Simplify NOTES formatting test by merging two tests into one
yotsuda Dec 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions src/System.Management.Automation/FormatAndOutput/DefaultFormatters/Help_format_ps1xml.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -680,10 +680,7 @@ private static IEnumerable<FormatViewDefinition> ViewsOf_MamlCommandHelpInfo_Ful
.StartFrame(leftIndent: 4)
.AddPropertyExpressionBinding(@"title")
.AddNewline()
.AddNewline()
.StartFrame(leftIndent: 4)
.AddPropertyExpressionBinding(@"alert", enumerateCollection: true, customControl: sharedControls[11])
.EndFrame()
.AddPropertyExpressionBinding(@"alert", enumerateCollection: true, customControl: sharedControls[11])
.AddNewline()
.EndFrame()
.EndEntry()
Expand Down
27 changes: 27 additions & 0 deletions test/powershell/Language/Scripting/ScriptHelp.NotesFormatting.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
}
}
Loading