From 95d547497d09be34ede0a4ca776111fd99c007be Mon Sep 17 00:00:00 2001 From: Oliver Lipkau Date: Thu, 10 Jan 2019 17:08:48 +0100 Subject: [PATCH] Fixed documentation of new parameter --- JiraPS/Public/Get-JiraUser.ps1 | 10 ++++----- docs/en-US/commands/Get-JiraUser.md | 32 +++++++++++++++-------------- 2 files changed, 22 insertions(+), 20 deletions(-) diff --git a/JiraPS/Public/Get-JiraUser.ps1 b/JiraPS/Public/Get-JiraUser.ps1 index 8c6b8a0b..aa18cc30 100644 --- a/JiraPS/Public/Get-JiraUser.ps1 +++ b/JiraPS/Public/Get-JiraUser.ps1 @@ -11,6 +11,10 @@ function Get-JiraUser { [Parameter( Position = 0, Mandatory, ParameterSetName = 'ByInputObject' )] [Object[]] $InputObject, + [Parameter( ParameterSetName = 'ByInputObject' )] + [Parameter( ParameterSetName = 'ByUserName' )] + [Switch]$Exact, + [Switch] $IncludeInactive, @@ -27,11 +31,7 @@ function Get-JiraUser { [Parameter()] [System.Management.Automation.PSCredential] [System.Management.Automation.Credential()] - $Credential = [System.Management.Automation.PSCredential]::Empty, - - [Parameter( ParameterSetName = 'ByInputObject' )] - [Parameter( ParameterSetName = 'ByUserName' )] - [Switch]$Exact + $Credential = [System.Management.Automation.PSCredential]::Empty ) begin { diff --git a/docs/en-US/commands/Get-JiraUser.md b/docs/en-US/commands/Get-JiraUser.md index b07c710c..fa55f7eb 100644 --- a/docs/en-US/commands/Get-JiraUser.md +++ b/docs/en-US/commands/Get-JiraUser.md @@ -66,7 +66,7 @@ This example returns the JIRA user that is executing the command. ### EXAMPLE 4 ```powershell -Get-JiraUser -UserName user1 -Exact +Get-JiraUser -UserName user1 -Exact ``` Returns information about user user1 @@ -105,6 +105,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Exact + +Limits the search to users where the username is exactly the term searched for. + +```yaml +Type: Switch +Parameter Sets: ByUserName, ByInputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IncludeInactive Include inactive users in the search @@ -174,20 +190,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SwitchParameter -Parameter Sets: ByUserName,ByInputObject -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - - - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.