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

Change commands arg name to the singular form #520

Merged
merged 2 commits into from
Mar 6, 2024

Conversation

tomalec
Copy link
Contributor

@tomalec tomalec commented Jul 10, 2023

The plural "commands" suggest that it can take many commands while it only works with one.

 USAGE 
   $ mycli help [COMMANDS] [-n] 

After reading the above, I'd expect mycli help lasers unicorns to show help for both commands, but it only shows for lasers.

 ARGUMENTS 
   COMMANDS  Command to show help for. 

On one hand, it explains that the argument takes only "Command" (singular).
But having "Commands - Command" makes my head wondering if it was a typo, and if so - where?

After tracking the change, I found it was changed from singular to plural in #454, but I cannot find there any reason why.

As the plural "commands" suggest that it can take many commands while it only works with one.
@salesforce-cla
Copy link

Thanks for the contribution! Before we can merge this, we need @tomalec to sign the Salesforce Inc. Contributor License Agreement.

@mdonnalley mdonnalley merged commit 3a71bdb into oclif:main Mar 6, 2024
1 check passed
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

Successfully merging this pull request may close these issues.

2 participants