fix: use blank-line description format for .INPUTS and .OUTPUTS#34
Merged
Marius Storhaug (MariusStorhaug) merged 1 commit intoJul 25, 2026
Merged
Conversation
Testing whether type + blank line + description paragraph passes PlatyPS + markdownlint in the Build-Docs pipeline. This is the format required by PR #69 discussion — descriptions are required, not optional. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Marius Storhaug (MariusStorhaug)
marked this pull request as ready for review
July 25, 2026 16:21
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Marius Storhaug (MariusStorhaug)
deleted the
inputs-outputs-description-format
branch
July 25, 2026 16:29
|
✅ New release: PowerShell Gallery - Template-PSModule 0.0.12 |
|
✅ New release: GitHub - Template-PSModule 0.0.12 |
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
1 participant
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.
What
Updates the scaffold function to use the blank-line description format for
.INPUTSand.OUTPUTScomment-based help:.INPUTS None You cannot pipe objects to this function. .OUTPUTS System.String A greeting string for the given name.Why
The type-name-only format works but gives callers no useful context. Descriptions are required — they should say what is actually piped in or returned, not just repeat the type name.
This PR is also a CI verification: confirming that the blank-line format (type → blank line → description paragraph) passes PlatyPS + markdownlint in Build-Docs. Previous attempts failed with:
System.String. Description.→ MD026 (trailing.in heading)The blank-line format should produce a clean
### typeheading with the description as body text below — no linting violations.Informs