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

Normalize capitalization and punctuation in command descriptions and summaries #1991

Merged
merged 15 commits into from
Jan 3, 2024

Conversation

adam-wolfe
Copy link
Contributor

@adam-wolfe adam-wolfe commented Dec 15, 2023

What It Does
Attempts to provide greater consistency in terms of punctuation and capitalization for Zowe CLI command help text.

General rules applied:

  • Capitalize the first letter of all descriptions, summaries, and options.
  • End every description with a period.
  • End every summary without a period (this requires shortening multi-sentence summaries to a single sentence).

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:

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>
Copy link

codecov bot commented Dec 15, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a5a6750) 91.03% compared to head (6f30932) 91.03%.
Report is 2 commits behind head on next.

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.
📢 Have feedback on the report? Share it here.

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>
Signed-off-by: Adam Wolfe <adam.wolfe@broadcom.com>
Signed-off-by: Adam Wolfe <adam.wolfe@broadcom.com>
@adam-wolfe adam-wolfe marked this pull request as ready for review December 28, 2023 20:05
Signed-off-by: Adam Wolfe <adam.wolfe@broadcom.com>
Copy link
Contributor

@ATorrise ATorrise left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

adam-wolfe and others added 2 commits January 3, 2024 11:02
Signed-off-by: Adam Wolfe <adam.wolfe@broadcom.com>
Copy link

sonarqubecloud bot commented Jan 3, 2024

@adam-wolfe adam-wolfe merged commit 879e8cb into next Jan 3, 2024
19 checks passed
@adam-wolfe adam-wolfe deleted the cap-and-punctuation branch January 3, 2024 18:49
Copy link

github-actions bot commented Jan 3, 2024

Release succeeded for the next branch. 🎉

The following packages have been published:

  • npm: @zowe/secrets-for-zowe-sdk@8.0.0-next.202401031939
  • npm: @zowe/imperative@8.0.0-next.202401031939
  • npm: @zowe/cli-test-utils@8.0.0-next.202401031939
  • npm: @zowe/core-for-zowe-sdk@8.0.0-next.202401031939
  • npm: @zowe/zos-uss-for-zowe-sdk@8.0.0-next.202401031939
  • npm: @zowe/provisioning-for-zowe-sdk@8.0.0-next.202401031939
  • npm: @zowe/zos-console-for-zowe-sdk@8.0.0-next.202401031939
  • npm: @zowe/zos-files-for-zowe-sdk@8.0.0-next.202401031939
  • npm: @zowe/zos-logs-for-zowe-sdk@8.0.0-next.202401031939
  • npm: @zowe/zosmf-for-zowe-sdk@8.0.0-next.202401031939
  • npm: @zowe/zos-workflows-for-zowe-sdk@8.0.0-next.202401031939
  • npm: @zowe/zos-jobs-for-zowe-sdk@8.0.0-next.202401031939
  • npm: @zowe/zos-tso-for-zowe-sdk@8.0.0-next.202401031939
  • npm: @zowe/cli@8.0.0-next.202401031939

Powered by Octorelease 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants