Commit 92d25fc
📖 [Docs]: Functions guide states that .INPUTS/.OUTPUTS descriptions are required (#81)
The `.INPUTS`/`.OUTPUTS` section of the Functions coding standard showed
the correct blank-line format but never stated that a description is
**mandatory**. Readers — and agents generating comment-based help —
could reasonably assume the type name alone is sufficient.
## Changed: Description requirement made explicit
A new first rule is added to the `### .INPUTS and .OUTPUTS` bullet list
making clear that every entry must include a description that says what
is actually piped in (`.INPUTS`) or returned (`.OUTPUTS`) in plain
language — not just a restatement of the type name.
## Technical Details
- Single bullet inserted as the first item in the rules list at the
bottom of the `### .INPUTS and .OUTPUTS` sub-section in
`src/docs/Coding-Standards/PowerShell/Functions.md`.
- No other content restructured.
<details>
<summary>Related issues</summary>
- Fixes #80
</details>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>1 parent d4c4a15 commit 92d25fc
1 file changed
Lines changed: 1 addition & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
146 | 146 | | |
147 | 147 | | |
148 | 148 | | |
| 149 | + | |
149 | 150 | | |
150 | 151 | | |
151 | 152 | | |
0 commit comments