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

Simplify settings help message #1052

Merged
merged 7 commits into from
Dec 20, 2024
Merged

Conversation

atravitz
Copy link
Contributor

This is just my opinion so I'm open to a veto, but I think that CLI help messages should be concise where possible.

@atravitz atravitz force-pushed the simplify_settings_help_message branch from 81d0137 to 4e937d0 Compare December 12, 2024 22:40
Copy link

🚨 API breaking changes detected! 🚨

1 similar comment
Copy link

🚨 API breaking changes detected! 🚨

Copy link

🚨 API breaking changes detected! 🚨

Copy link

🚨 API breaking changes detected! 🚨

@atravitz atravitz marked this pull request as ready for review December 12, 2024 22:53
Copy link

codecov bot commented Dec 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.84%. Comparing base (76127a1) to head (79f34db).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1052      +/-   ##
==========================================
- Coverage   94.57%   92.84%   -1.73%     
==========================================
  Files         135      135              
  Lines       10061    10061              
==========================================
- Hits         9515     9341     -174     
- Misses        546      720     +174     
Flag Coverage Δ
fast-tests 92.84% <ø> (?)
slow-tests ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jthorton
Copy link
Collaborator

I agree it should give a brief example and then point to the docs which lists all the choices!

@IAlibay
Copy link
Member

IAlibay commented Dec 13, 2024

I've not read the change but I agree to simplifying too!

Copy link

🚨 API breaking changes detected! 🚨

@hannahbaumann hannahbaumann self-requested a review December 17, 2024 12:22
@hannahbaumann hannahbaumann self-assigned this Dec 17, 2024
Copy link
Contributor

@hannahbaumann hannahbaumann left a comment

Choose a reason for hiding this comment

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

Lgtm @atravitz , just left that one comment!

openfecli/parameters/plan_network_options.py Outdated Show resolved Hide resolved
Copy link
Contributor

@hannahbaumann hannahbaumann left a comment

Choose a reason for hiding this comment

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

Thanks @atravitz , lgtm!

Copy link

No API break detected ✅

@atravitz atravitz merged commit bb90b07 into main Dec 20, 2024
11 checks passed
@atravitz atravitz deleted the simplify_settings_help_message branch December 20, 2024 16:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants