Skip to content

Commit

Permalink
curate format-dates: Update first line of help docs
Browse files Browse the repository at this point in the history
Make it clear that the incomplete dates are not automatically masked.
The user has to explicitly provide the incomplete date formats.
  • Loading branch information
joverlee521 committed Oct 17, 2024
1 parent 862aa37 commit 7f57bd1
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions augur/curate/format_dates.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
"""
Format date fields to ISO 8601 dates (YYYY-MM-DD), where incomplete dates
are masked with 'XX' (e.g. 2023 -> 2023-XX-XX).
Format date fields to ISO 8601 dates (YYYY-MM-DD).
If the provided ``--expected-date-formats`` represent incomplete dates then
the incomplete dates are masked with 'XX'. For example, providing
``%Y`` will allow year only dates to be formatted as ``2023-XX-XX``.
"""
import re
from datetime import datetime
Expand Down

0 comments on commit 7f57bd1

Please sign in to comment.