-
Notifications
You must be signed in to change notification settings - Fork 130
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
Add help text to clarify extend actions #1705
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #1705 +/- ##
==========================================
- Coverage 72.82% 72.72% -0.10%
==========================================
Files 79 79
Lines 8272 8286 +14
Branches 1691 1697 +6
==========================================
+ Hits 6024 6026 +2
- Misses 1960 1972 +12
Partials 288 288 ☔ View full report in Codecov by Sentry. |
Start with a copy of ArgumentDefaultsHelpFormatter. To be modified.
This is only meaningful for options that have default values specified.
9bf885e
to
3d71c25
Compare
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.
didn't test, code looks okay
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.
I wish there was a way for the CustomHelpFormatter
output to be included in the auto-generated docs via sphinx-argparse, but I don't think that's possible from briefly browsing sphinx-argparse docs.
@joverlee521 good note, opened an issue: #1706 |
Description of proposed changes
Done programmatically by replacing
ArgumentDefaultsHelpFormatter
with a newCustomHelpFormatter
.Related issue(s)
extend
andExtendOverwriteDefault
actions #1654Checklist
Automated checks pass
Check if you need to add a changelog message
Check if you need to add tests
Check if you need to update docs
Tested locally with output of
augur curate format-dates -h
: