-
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
Normalize capitalization and punctuation in command descriptions and summaries #1991
Conversation
Signed-off-by: Adam Wolfe <adam.wolfe@broadcom.com>
Signed-off-by: Adam Wolfe <adam.wolfe@broadcom.com>
Signed-off-by: Adam Wolfe <adam.wolfe@broadcom.com>
Signed-off-by: Adam Wolfe <adam.wolfe@broadcom.com>
Signed-off-by: Adam Wolfe <adam.wolfe@broadcom.com>
Signed-off-by: Adam Wolfe <adam.wolfe@broadcom.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## next #1991 +/- ##
=======================================
Coverage 91.03% 91.03%
=======================================
Files 635 635
Lines 18608 18610 +2
Branches 3859 3859
=======================================
+ Hits 16939 16941 +2
Misses 1668 1668
Partials 1 1 ☔ View full report in Codecov by Sentry. |
Signed-off-by: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com>
Signed-off-by: adam-wolfe <122040687+adam-wolfe@users.noreply.github.com>
Signed-off-by: Adam Wolfe <adam.wolfe@broadcom.com>
…into cap-and-punctuation
Signed-off-by: Adam Wolfe <adam.wolfe@broadcom.com>
Signed-off-by: Adam Wolfe <adam.wolfe@broadcom.com>
Signed-off-by: Adam Wolfe <adam.wolfe@broadcom.com>
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.
👍
Signed-off-by: Adam Wolfe <adam.wolfe@broadcom.com>
Quality Gate passedKudos, no new issues were introduced! 0 New issues |
Release succeeded for the The following packages have been published:
Powered by Octorelease 🚀 |
What It Does
Attempts to provide greater consistency in terms of punctuation and capitalization for Zowe CLI command help text.
General rules applied:
Automating enforcement of these rules may be too complicated unless there is a way to programmatically get all help strings. Scanning the code line-by-line can be easily confounded by use of variables instead of literals.
I left option descriptions and examples mostly as they were.
How to Test
Try some zowe commands and look at the help text. Everything should start with a capital letter. Descriptions end with a period. Summaries end without a period unless they are multiple sentences.
Review Checklist
I certify that I have: