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.

Sign up for GitHub

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

Jump to bottom

Update docs for curate format-dates #1653

Merged
merged 4 commits into from
Nov 6, 2024
Merged

Update docs for curate format-dates #1653

merged 4 commits into from
Nov 6, 2024

Commits on Nov 6, 2024

  1. curate format-dates: Update first line of help docs 

    Make it clear that the incomplete dates are not automatically masked.
The user has to explicitly provide the incomplete date formats.
    @joverlee521
    joverlee521 committed Nov 6, 2024
    Configuration menu
    Copy the full SHA
    3401422 View commit details
    Browse the repository at this point in the history

  2. curate format-dates: Move --expected-date-formats to optional args 

    Because of the added default values in
<#1501>, this is no longer a
required argument.

The alternative is to explicitly mark this option as `required=True`,
but that's a breaking change that can be considered later. Currently,
if `--expected-date-formats` is not provided and dates match the
defaults, then it's a no-op. If dates do not match the default formats,
it will raise a loud error so the user can add the custom formats.
    @joverlee521
    joverlee521 committed Nov 6, 2024
    Configuration menu
    Copy the full SHA
    2afb57c View commit details
    Browse the repository at this point in the history

  3. curate format-dates: Add hint for failure messages 

    When a date parsing failure occurs, show the current expected date
formats with the hint that they can be updated
via `--expected-date-formats`.
    @joverlee521
    joverlee521 committed Nov 6, 2024
    Configuration menu
    Copy the full SHA
    a11869b View commit details
    Browse the repository at this point in the history

  4. Update changelog

    @joverlee521
    joverlee521 committed Nov 6, 2024
    Configuration menu
    Copy the full SHA
    c7e8a31 View commit details
    Browse the repository at this point in the history