Skip to content

Commit 3a014c0

Browse files
authored
Add Example Parameter Description Text (#16)
- Add parameter description to example function in template module
1 parent dffe229 commit 3a014c0

3 files changed

Lines changed: 10 additions & 2 deletions

File tree

Stucco/template/module/Public/Get-HelloWorld.ps1

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,13 @@ Function Get-HelloWorld {
1010
1111
Runs the command
1212
#>
13-
$value = GetHelloWorld
14-
$value
13+
[CmdletBinding()]
14+
param (
15+
# Parameter description can go here or above in format: .PARAMETER <Parameter-Name>
16+
[Parameter()]
17+
[string]
18+
$Value = 'GetHelloWorld'
19+
)
20+
21+
$Value
1522
}

Stucco/template/psakeFile.ps1

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ properties {
44
# in the PowerShellBuild shared psake task module
55
$PSBPreference.Build.CompileModule = $false
66
$PSBPreference.Help.DefaultLocale = 'en-US'
7+
$PSBPreference.Test.OutputFile = 'out/testResults.xml'
78
}
89

910
task default -depends Test

Stucco/template/tests/out/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)