-
-
Notifications
You must be signed in to change notification settings - Fork 130
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
Unify Label parameter names to singular form in New-
/Set-JiraIssue
#522
Unify Label parameter names to singular form in New-
/Set-JiraIssue
#522
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the PR.
My first impression is that -Labels
(in plural) would be better, as one would expect a list.
Even the jql uses plural labels = api
.
Do you agree?
I went back and forth on this a bit. I agree that the Jira API uses the plural form and that, from the perspective of "we should match the behavior of the API", the plural form makes the most sense. OTOH, PowerShell's development guidelines strongly recommend singular-noun parameter names, even for params that can take multivalued/array-type arguments. If you look at builtins like Looking at prior art within the module, I would posit that singular noun is best (as it's more closely aligned with best practices for the language) with |
Agreed. |
Done: #523 |
Description
This PR aligns the naming convention for label parameters between
New-JiraIssue
andSet-JiraIssue
.Motivation and Context
Resolves #521.
New-JiraIssue
takes-Labels
, whereasSet-JiraIssue
takes-Label
. This PR updates both to be-Label
with-Labels
as an alias for backwards compatibility.Types of changes
Checklist