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

Doc hotfix: Correct date formats #216

Merged
merged 2 commits into from
Jul 20, 2023
Merged

Doc hotfix: Correct date formats #216

merged 2 commits into from
Jul 20, 2023

Conversation

zmbc
Copy link
Collaborator

@zmbc zmbc commented Jul 7, 2023

Doc hotfix: Correct date formats

Description

  • Category: documentation
  • JIRA issue: none

Previously our docs said all datasets had dates in YYYY-MM-DD. In fact, this is not the case.

You can see that this matches the code here:

if COLUMNS.ssa_event_date.name in data.columns and dataset == DATASETS.ssa:
# event_date -> YYYYMMDD
data[COLUMNS.ssa_event_date.name] = data[COLUMNS.ssa_event_date.name].dt.strftime(
"%Y%m%d"
)
if COLUMNS.dob.name in data.columns:
# date_of_birth -> MM/DD/YYYY
data[COLUMNS.dob.name] = data[COLUMNS.dob.name].dt.strftime("%m/%d/%Y")

Note that this code is also wrong, in that it does not match the concept model.
I will make another PR against develop to get everything (code and docs) in alignment with the concept model.

Testing

Built docs locally.

@zmbc zmbc added documentation Improvements or additions to documentation hotfix Urgent update to be merged to main instead of develop labels Jul 7, 2023
@zmbc zmbc requested review from a team and pletale as code owners July 7, 2023 22:25
Copy link
Member

@aflaxman aflaxman left a comment

Choose a reason for hiding this comment

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

Idea: allow users to choose any date format in the config, and use these as the defaults

@rmudambi rmudambi merged commit 4183f14 into main Jul 20, 2023
@rmudambi rmudambi deleted the doc-hotfix/date-formats branch July 20, 2023 19:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation hotfix Urgent update to be merged to main instead of develop
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants