Skip to content

Commit 157c089

Browse files
fix: complete comment-based help in scaffold function
Add missing .INPUTS and .OUTPUTS sections required by the PowerShell functions standard. Clarify .SYNOPSIS/.DESCRIPTION (they were identical and said 'performs tests' when the function actually greets). Fix the .EXAMPLE output (remove spurious quotes around the output string). Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent 3f868a3 commit 157c089

1 file changed

Lines changed: 11 additions & 4 deletions

File tree

src/functions/public/Get-PSModuleTest.ps1

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,27 @@
11
function Get-PSModuleTest {
22
<#
33
.SYNOPSIS
4-
Performs tests on a module.
4+
Greets an entity by name.
55
66
.DESCRIPTION
7-
Performs tests on a module.
7+
Returns a greeting string for the given name.
8+
This is a scaffold example function. Replace it with your module's first real command.
89
910
.EXAMPLE
1011
Get-PSModuleTest -Name 'World'
1112
12-
"Hello, World!"
13+
Hello, World!
14+
15+
.INPUTS
16+
None. This function does not accept pipeline input.
17+
18+
.OUTPUTS
19+
[string] A greeting string.
1320
#>
1421
[OutputType([string])]
1522
[CmdletBinding()]
1623
param (
17-
# Name of the person to greet.
24+
# The name of the entity to greet.
1825
[Parameter(Mandatory)]
1926
[string] $Name
2027
)

0 commit comments

Comments
 (0)