-
Notifications
You must be signed in to change notification settings - Fork 128
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
Improve help text of CLI options that use extend
and ExtendOverwriteDefault
actions
#1654
Comments
I think the current text is ambiguous for both --metadata-delimiters METADATA_DELIMITERS [METADATA_DELIMITERS ...]
Delimiters to accept when reading a plain text metadata file. Only one delimiter will be inferred.
+ Specified values will override the default list.
(default: (',', '\t'))
--expected-date-formats EXPECTED_DATE_FORMATS [EXPECTED_DATE_FORMATS ...]
Expected date formats that are currently in the provided date fields, defined by standard format codes as listed at
https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes. If a date string matches multiple formats, it will be parsed as the
first matched format in the provided order.
+ Specified values will extend the default list.
(default: ['%Y-%m-%d', '%Y-%m-XX', '%Y-XX-XX', 'XXXX-XX-XX']) |
This makes me wonder why In all other usages besides For |
Not being able to override the defaults for |
That looks great! Let's do it. I don't think it's blocked on the newline formatting. |
#1705 improves the help text for existing behavior. I still think we can consider replacing all of |
Initially discussed in #1653 (comment).
The default behavior for the extend action in argparse is to extend the defaults. We have a custom ExtendOverwriteDefault action that overwrites the defaults instead of extending them, but this custom action does not change the output of the CLI help docs.
Comparing
--metadata-delimiters
which usesExtendOverwriteDefault
and--expected-date-formats
which uses the defaultextend
action fromaugur curate format-dates
. The help text does not differentiate the extend vs overwrite behavior.The text was updated successfully, but these errors were encountered: