Add comment-based help documentation to build.psm1 functions#27122
Merged
daxian-dbw merged 4 commits intoPowerShell:masterfrom Mar 31, 2026
Merged
Add comment-based help documentation to build.psm1 functions#27122daxian-dbw merged 4 commits intoPowerShell:masterfrom
daxian-dbw merged 4 commits intoPowerShell:masterfrom
Conversation
Add comprehensive CBH (.SYNOPSIS, .DESCRIPTION, .PARAMETER, .OUTPUTS) to all module-level functions in build.psm1 that were previously undocumented. This covers ~60 functions including build, test, restore, bootstrap, NuGet, CI/pipeline, and utility functions.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds comment-based help (CBH) to build.psm1 module functions so build/test/bootstrap/CI utilities surface discoverable help via Get-Help, improving maintainability and usability of the build tooling.
Changes:
- Added CBH blocks (
.SYNOPSIS,.DESCRIPTION,.PARAMETER,.OUTPUTS) across many existing functions inbuild.psm1. - Replaced an old inline comment block in
ConvertFrom-PesterLogwith proper CBH. - Minor whitespace/formatting touch-ups adjacent to the new help blocks.
Co-authored-by: Copilot <[email protected]>
daxian-dbw
added
the
CL-BuildPackaging
daxian-dbw
pushed a commit
to daxian-dbw/PowerShell
that referenced
this pull request
Apr 9, 2026
9 tasks
daxian-dbw
pushed a commit
to daxian-dbw/PowerShell
that referenced
this pull request
Apr 9, 2026
9 tasks
daxian-dbw
pushed a commit
to daxian-dbw/PowerShell
that referenced
this pull request
Apr 9, 2026
9 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add comprehensive CBH (.SYNOPSIS, .DESCRIPTION, .PARAMETER, .OUTPUTS) to all module-level functions in build.psm1 that were previously undocumented. This covers ~60 functions including build, test, restore, bootstrap, NuGet, CI/pipeline, and utility functions.
PR Summary
PR Context
PR Checklist
.h,.cpp,.cs,.ps1and.psm1files have the correct copyright header