Skip to content

Commit 41c5702

Browse files
Merge pull request #183 from PowershellFrameworkCollective/HelpUri
Updated HelpUri and added Pester test
2 parents 55cb65f + 57a0d24 commit 41c5702

61 files changed

Lines changed: 160 additions & 70 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

PSFramework/functions/ComputerManagement/Invoke-PSFCommand.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
Runs the $scriptblock against all computers in AD with a name that starts with "srv-db".
5252
#>
5353
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSPossibleIncorrectUsageOfAssignmentOperator", "")]
54-
[CmdletBinding()]
54+
[CmdletBinding(HelpUri = 'https://psframework.org/documentation/commands/PSFramework/Invoke-PSFCommand')]
5555
param (
5656
[PSFComputer[]]
5757
[Alias('Session')]

PSFramework/functions/configuration/Export-PSFConfig.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
5555
Exports all settings of the module 'MyModule' that are no longer the original default values to json.
5656
#>
57-
[CmdletBinding(DefaultParameterSetName = 'FullName')]
57+
[CmdletBinding(DefaultParameterSetName = 'FullName', HelpUri = 'https://psframework.org/documentation/commands/PSFramework/Export-PSFConfig')]
5858
Param (
5959
[Parameter(ParameterSetName = "FullName", Position = 0, Mandatory = $true)]
6060
[string]

PSFramework/functions/configuration/Get-PSFConfig.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
Retrieve all configuration elements from all modules, even hidden ones.
3636
#>
3737
[OutputType([PSFramework.Configuration.Config])]
38-
[CmdletBinding(DefaultParameterSetName = "FullName")]
38+
[CmdletBinding(DefaultParameterSetName = "FullName", HelpUri = 'https://psframework.org/documentation/commands/PSFramework/Get-PSFConfig')]
3939
Param (
4040
[Parameter(ParameterSetName = "FullName", Position = 0)]
4141
[string]

PSFramework/functions/configuration/Get-PSFConfigValue.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
Returns the configured value for 'Default.CoffeeMilk'. If no such value is configured, it returns '0' instead.
3232
#>
3333
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSPossibleIncorrectComparisonWithNull", "")]
34-
[CmdletBinding()]
34+
[CmdletBinding(HelpUri = 'https://psframework.org/documentation/commands/PSFramework/Get-PSFConfigValue')]
3535
Param (
3636
[Alias('Name')]
3737
[Parameter(Mandatory = $true)]

PSFramework/functions/configuration/Import-PSFConfig.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
Imports all the module specific settings that have been persisted in any of the default file system paths.
4646
#>
4747
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingEmptyCatchBlock", "")]
48-
[CmdletBinding(DefaultParameterSetName = "Path")]
48+
[CmdletBinding(DefaultParameterSetName = "Path", HelpUri = 'https://psframework.org/documentation/commands/PSFramework/Import-PSFConfig')]
4949
param (
5050
[Parameter(Mandatory = $true, ValueFromPipeline = $true, ParameterSetName = "Path")]
5151
[string[]]

PSFramework/functions/configuration/Register-PSFConfig.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
4848
Retrieves all configuration items of the module MyModule, then registers them in registry to enforce them for all users on the current system.
4949
#>
50-
[CmdletBinding(DefaultParameterSetName = "Default")]
50+
[CmdletBinding(DefaultParameterSetName = "Default", HelpUri = 'https://psframework.org/documentation/commands/PSFramework/Register-PSFConfig')]
5151
Param (
5252
[Parameter(ParameterSetName = "Default", Position = 0, ValueFromPipeline = $true)]
5353
[PSFramework.Configuration.Config[]]

PSFramework/functions/configuration/Register-PSFConfigValidation.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
2727
Registers the scriptblock stored in $scriptblock as validation with the name IntPositive
2828
#>
29-
[CmdletBinding()]
29+
[CmdletBinding(HelpUri = 'https://psframework.org/documentation/commands/PSFramework/Register-PSFConfigValidation')]
3030
Param (
3131
[Parameter(Mandatory = $true)]
3232
[string]

PSFramework/functions/configuration/Reset-PSFConfig.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
5151
Resets the configuration item named 'MyModule.Group.Setting1'.
5252
#>
53-
[CmdletBinding(DefaultParameterSetName = 'Pipeline', SupportsShouldProcess = $true, ConfirmImpact = 'Low')]
53+
[CmdletBinding(DefaultParameterSetName = 'Pipeline', SupportsShouldProcess = $true, ConfirmImpact = 'Low', HelpUri = 'https://psframework.org/documentation/commands/PSFramework/Reset-PSFConfig')]
5454
param (
5555
[Parameter(ValueFromPipeline = $true, ParameterSetName = 'Pipeline')]
5656
[PSFramework.Configuration.Config[]]

PSFramework/functions/configuration/Unregister-PSFConfig.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
4646
Unregisters all configuration settings for the module MyModule.
4747
#>
48-
[CmdletBinding(DefaultParameterSetName = 'Pipeline')]
48+
[CmdletBinding(DefaultParameterSetName = 'Pipeline', HelpUri = 'https://psframework.org/documentation/commands/PSFramework/Unregister-PSFConfig')]
4949
param (
5050
[Parameter(ValueFromPipeline = $true, ParameterSetName = 'Pipeline')]
5151
[PSFramework.Configuration.Config[]]

PSFramework/functions/flowcontrol/Stop-PSFFunction.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@
109109
In both cases, the error record added to $error will have the content of $foo added, the better to figure out what went wrong.
110110
#>
111111
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
112-
[CmdletBinding(DefaultParameterSetName = 'Plain')]
112+
[CmdletBinding(DefaultParameterSetName = 'Plain', HelpUri = 'https://psframework.org/documentation/commands/PSFramework/Stop-PSFFunction')]
113113
param (
114114
[Parameter(Mandatory = $true)]
115115
[string]

0 commit comments

Comments
 (0)