Skip to content

Commit 6b0b3bc

Browse files
committed
Refine function documentation guidelines by clarifying parameter block structure and comment-based help formatting
1 parent 2a47da5 commit 6b0b3bc

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

.github/instructions/dsc-community-style-guidelines.instructions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,9 @@ function Get-Something
103103

104104
- Include `[CmdletBinding()]` on every function
105105
- Parameter block at top
106-
- Non-empty parameter has opening and closing parentheses on their own line (empty `param ()` if no parameters)
107-
- Comment-based help with SYNOPSIS, DESCRIPTION and PARAMETER sections, before the function or class keyword
108-
- Each comment-based help keyword should be indented with 4 spaces and each keyword's text should be indented 8 spaces.
106+
- Parameter block: `param ()` if empty, else opening/closing parentheses on own lines
107+
- Comment-based help: SYNOPSIS, DESCRIPTION, PARAMETER sections before function/class
108+
- Help indentation: keywords 4 spaces, text 8 spaces
109109
- `[OutputType()]` for functions with output
110110
- All parameters use `[Parameter()]` attribute, mandatory parameters use `[Parameter(Mandatory = $true)]`
111111
- Parameter attributes on separate lines

0 commit comments

Comments
 (0)