Skip to content

Turn off endpoint missing checks for geo_values and time_values, which have defaults #268

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

Merged
merged 6 commits into from
Mar 5, 2024

Conversation

nmdefries
Copy link
Contributor

@nmdefries nmdefries commented Mar 4, 2024

Checklist

Please:

  • Make sure this PR is against "dev", not "main" (unless this is a release
    PR).
  • Request a review from one of the current epidatr main reviewers:
    brookslogan, dshemetov, nmdefries, dsweber2.
  • Makes sure to bump the version number in DESCRIPTION. Always increment
    the patch version number (the third number), unless you are making a
    release PR from dev to main, in which case increment the minor version
    number (the second number).
  • Describe changes made in NEWS.md, making sure breaking changes
    (backwards-incompatible changes to the documented interface) are noted.
    Collect the changes under the next release number (e.g. if you are on
    1.7.2, then write your changes under the 1.8 heading).

Change explanations for reviewer

missing doesn't count default values as non-missing. If a user doesn't pass geo_values or time_values (both of which default to "*" in pub_covidcast), or dates (in pub_covid_hosp_state_timeseries), the missing check fails. To avoid this, just don't check missingness of those two arguments.

Magic GitHub syntax to mark associated Issue(s) as resolved when this is merged into the default branch

Copy link
Contributor

@dshemetov dshemetov left a comment

Choose a reason for hiding this comment

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

Good catch. Could you also add lines to the documentation that says that geo_value=* and time_value=* is default?

@nmdefries nmdefries requested a review from dshemetov March 4, 2024 23:39
Copy link
Contributor

@dshemetov dshemetov left a comment

Choose a reason for hiding this comment

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

lgtm

@nmdefries nmdefries marked this pull request as ready for review March 5, 2024 01:58
@nmdefries nmdefries merged commit c33d7c2 into dev Mar 5, 2024
@nmdefries nmdefries deleted the ndefries/less-sensitive-missing-checks branch March 5, 2024 01:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants