Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inconsistent Label parameter name between New-JiraIssue and Set-JiraIssue #521

Closed
hmmwhatsthisdo opened this issue Sep 24, 2024 · 1 comment

Comments

@hmmwhatsthisdo
Copy link
Contributor

Description

New-JiraIssue declares a parameter named -Labels <string[]> for setting labels on an issue. On Set-JiraIssue, however, the corresponding parameter name is simply -Label <string[]> (singular form).

This is confusing to end-users and hampers discoverability of either parameter (as someone reusing code might try changing New- to Set- or vice-versa)

Steps To Reproduce

N/A

Expected behavior

New-JiraIssue and Set-JiraIssue have identically-named parameters when parameters shared between both cmdlets have the same function.

Screenshots

N/A

Your Environment

Get-Module JiraPS -ListAvailable | Select Name, Version
$PSVersionTable

PS C:> Get-Module JiraPS -ListAvailable | Select Name, Version

Name Version


JiraPS 2.15.0
JiraPS 2.14.7
JiraPS 2.14.7

PS C:> $PSVersionTable

Name Value


PSVersion 7.4.5
PSEdition Core
GitCommitId 7.4.5
OS Microsoft Windows 10.0.19045
Platform Win32NT
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
WSManStackVersion 3.0

Possible Solution

Easiest fix here is likely to use the singular-noun form (-Label) and make -Labels an [Alias()].

@hmmwhatsthisdo
Copy link
Contributor Author

Fixed in #522.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant