Skip to content

Commit

Permalink
Fixed documentation of new parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
lipkau committed Jan 10, 2019
1 parent 74a3f61 commit 95d5474
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 20 deletions.
10 changes: 5 additions & 5 deletions JiraPS/Public/Get-JiraUser.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -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,

Expand All @@ -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 {
Expand Down
32 changes: 17 additions & 15 deletions docs/en-US/commands/Get-JiraUser.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 95d5474

Please sign in to comment.