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

Standardize use of capitalization and punctuation in command descriptions #1756

Closed
adam-wolfe opened this issue Jul 21, 2023 · 5 comments
Closed
Labels
enhancement New feature or request keep Issues with this label will be ignored by the stale bot priority-medium Not functioning - next quarter if capacity permits

Comments

@adam-wolfe
Copy link
Contributor

adam-wolfe commented Jul 21, 2023

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 for zowe zos-files compare does not end with a period, but the description for zowe 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 for zowe config auto-init begins with a capital letter while the description for zowe 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:
image

zowe config:
image

@adam-wolfe adam-wolfe added enhancement New feature or request new The issue wasn't triaged yet labels Jul 21, 2023
@github-actions
Copy link

Thank you for raising this enhancement request.
The community has 90 days to vote on it.
If the enhancement receives at least 5 upvotes, it is added to our development backlog.
If it receives fewer votes, the issue is closed.

@zFernand0 zFernand0 added priority-medium Not functioning - next quarter if capacity permits and removed new The issue wasn't triaged yet labels Aug 9, 2023
@adam-wolfe adam-wolfe mentioned this issue Sep 27, 2023
20 tasks
Copy link

github-actions bot commented Nov 7, 2023

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

@github-actions github-actions bot added the Stale label Nov 7, 2023
@adam-wolfe adam-wolfe mentioned this issue Nov 20, 2023
26 tasks
Copy link

This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Nov 21, 2023
@adam-wolfe
Copy link
Contributor Author

Still planning to do this.

@adam-wolfe adam-wolfe reopened this Nov 21, 2023
@adam-wolfe adam-wolfe added keep Issues with this label will be ignored by the stale bot and removed Stale labels Nov 21, 2023
@t1m0thyj t1m0thyj moved this to Medium Priority in Zowe CLI Squad Dec 26, 2023
@adam-wolfe
Copy link
Contributor Author

Implemented in #1991

@github-project-automation github-project-automation bot moved this from Medium Priority to Closed in Zowe CLI Squad Jan 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request keep Issues with this label will be ignored by the stale bot priority-medium Not functioning - next quarter if capacity permits
Projects
None yet
Development

No branches or pull requests

2 participants