Skip to content

Commit 20f43c5

Browse files
committed
Fix help
1 parent 04b0a35 commit 20f43c5

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

PSModuleDevelopment/PSModuleDevelopment.psd1

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@
8989
'Set-PSMDCmdletBinding',
9090
'Set-PSMDModulePath',
9191
'Set-PSMDParameterHelp',
92+
'Show-PSMDSyntax',
9293
'Split-PSMDScriptFile'
9394
)
9495

PSModuleDevelopment/functions/utility/Show-PSMDSyntax.ps1

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@
1414
If there is parameter value present, you have to use the opposite quote strategy to encapsulate the string correctly
1515
1616
E.g. for double quotes
17-
-CommandText 'Import-D365Bacpac -ImportModeTier2 -SqlUser "sqladmin" -SqlPwd "XyzXyz" -BacpacFile2 "C:\temp\uat.bacpac"'
17+
-CommandText 'New-Item -Path "c:\temp\newfile.txt"'
1818
1919
E.g. for single quotes
20-
-CommandText "Import-D365Bacpac -ExportModeTier2 -SqlUser 'sqladmin' -SqlPwd 'XyzXyz' -BacpacFile2 'C:\temp\uat.bacpac'"
20+
-CommandText "New-Item -Path 'c:\temp\newfile.txt'"
2121
2222
.PARAMETER Mode
2323
The operation mode of the cmdlet / function
@@ -26,17 +26,17 @@
2626
- Validate
2727
- ShowParameters
2828
29-
.PARAMETER IncludeHelp
30-
Switch to instruct the cmdlet / function to output a simple guide with the colors in it
29+
.PARAMETER Legend
30+
Include a legend explaining the color mapping
3131
3232
.EXAMPLE
33-
PS C:\> Show-PSMDSyntax -CommandText 'Import-D365Bacpac -ImportModeTier2 -SqlUser "sqladmin" -SqlPwd "XyzXyz" -BacpacFile2 "C:\temp\uat.bacpac"' -Mode "Validate"
33+
PS C:\> Show-PSMDSyntax -CommandText "New-Item -Path 'c:\temp\newfile.txt'" -Mode "Validate"
3434
3535
This will validate all the parameters that have been passed to the Import-D365Bacpac cmdlet.
3636
All supplied parameters that matches a parameter will be marked with an asterisk.
3737
3838
.EXAMPLE
39-
PS C:\> Show-PSMDSyntax -CommandText 'Import-D365Bacpac' -Mode "ShowParameters"
39+
PS C:\> Show-PSMDSyntax -CommandText "New-Item" -Mode "ShowParameters"
4040
4141
This will display all the parameter sets and their individual parameters.
4242
@@ -54,7 +54,7 @@
5454
[ValidateSet('Validate', 'ShowParameters')]
5555
[string] $Mode,
5656

57-
[switch] $IncludeHelp
57+
[switch] $Legend
5858
)
5959

6060
$commonParameters = 'Verbose', 'Debug', 'ErrorAction', 'WarningAction', 'InformationAction', 'ErrorVariable', 'WarningVariable', 'InformationVariable', 'OutVariable', 'OutBuffer', 'PipelineVariable', 'Confirm', 'WhatIf'

0 commit comments

Comments
 (0)