-
Notifications
You must be signed in to change notification settings - Fork 86
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
Standardize use of capitalization and punctuation in command descriptions #1756
Comments
Thank you for raising this enhancement request. |
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. |
This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. |
Still planning to do this. |
Implemented in #1991 |
Is your feature or enhancement request related to a problem or limitation? Please describe
Punctuation at the end of command description varies between commands. For example, enter
zowe zos-files
. The description forzowe zos-files compare
does not end with a period, but the description forzowe zos-files copy
does.There is also inconsistency with respect to capitalization of the first word in command descriptions. For example, enter
zowe config
. The description forzowe config auto-init
begins with a capital letter while the description forzowe config edit
does not.Describe your enhancement idea
Command descriptions should adhere to punctuation and capitalization rules across all available commands.
As far as I know, there is no industry standard for how command/option descriptions should be formatted. Some examples (in terms of command line options descriptions): Node.js is inconsistent, Python and Java seem to favor lowercase first character and no ending punctuation, Dotnet and VS Code (when called from the command line) use upper case first character and do end with a period.
In my opinion, it would be reasonable for all command descriptions to start with a capital letter (unless there is a specific reason against it) and end with a period (unless the description is a single word, or lacks a predicate).
Describe alternatives you've considered
Provide any additional context
zowe files:
zowe config:
The text was updated successfully, but these errors were encountered: