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

Reformat command line help descriptions #90

Merged
merged 1 commit into from
Jun 23, 2023

Conversation

altheaden
Copy link
Collaborator

While testing, I noticed that some of these descriptions had typos that made them hard to read. I went ahead and looked through other argument parsing help messages to fix some typos and generally make the formatting consistent (such as adding or removing periods).

Checklist

  • Testing comment in the PR documents testing used to verify the changes

@altheaden altheaden requested a review from xylar June 22, 2023 23:11
@altheaden
Copy link
Collaborator Author

altheaden commented Jun 22, 2023

I tested this branch with the PR suite against a baseline, which passed after removing the ocean/manufactured_solution/convergence test from the suite (currently experiencing an issue with that test, see #89).

Copy link
Collaborator

@xylar xylar left a comment

Choose a reason for hiding this comment

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

One small formatting suggestion but this looks great!

(Geez, who wrote this code in the first place?! Thanks for cleaning up my mess.)

polaris/list.py Outdated
Comment on lines 138 to 139
help='List supported machines (instead of test '
'cases).')
Copy link
Collaborator

Choose a reason for hiding this comment

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

To make the linter happy:

Suggested change
help='List supported machines (instead of test '
'cases).')
help='List supported machines (instead of test '
'cases).')

Comment on lines +303 to +305
"'polaris list'. Can be a space-separated "
"list of case numbers. A suffix 'c' indicates "
"that all steps in the test should use cached "
Copy link
Collaborator

Choose a reason for hiding this comment

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

Oh, no! Nice catch!

@xylar xylar added framework Changes relating to the polaris framework as opposed to individual tests or analysis utility Utility script(s) in the utils directory labels Jun 23, 2023
@xylar
Copy link
Collaborator

xylar commented Jun 23, 2023

Feel free to merge this yourself once you've made that one formatting change.

While testing, I noticed that some of these descriptions had typos that made them hard to read. I went ahead and looked through other argument parsing help messages to fix some typos and generally make the formatting consistent (such as adding or removing periods).
@altheaden altheaden force-pushed the reformat-help-messages branch from d041d8f to 51bcd5d Compare June 23, 2023 19:14
@altheaden altheaden merged commit 311505e into E3SM-Project:main Jun 23, 2023
@altheaden altheaden deleted the reformat-help-messages branch June 23, 2023 19:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clean-up framework Changes relating to the polaris framework as opposed to individual tests or analysis utility Utility script(s) in the utils directory
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants