Skip to content

Get CHC to pass pydocstyle #569

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
Dec 2, 2020
Merged

Get CHC to pass pydocstyle #569

merged 6 commits into from
Dec 2, 2020

Conversation

chinandrew
Copy link
Contributor

Description

Fix docs on chc indicator so pydocstyle passes.

Changelog

Itemize code/test/documentation changes and files added/removed.

  • Fix linting errors
  • Enable pydocstyle to run in makefile so it gets run on CI

Fixes

  • n/a

@chinandrew chinandrew mentioned this pull request Nov 20, 2020
7 tasks
visits (denominator), until we have observed some minimum number of
counts, then calculate the sum over that bin. We restrict the
bin size so to avoid inluding long-past values.
Adjust for backfills (retroactively added observations) by using a variable length smoother.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is pydocstyle forcing you to use a plural here? We use backfill to mean the phenomenon of retroactively added observations, rather than referring to the observations themselves.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

it didn't like the fact that the summary had the exact same word as the method. I reordered in a way to make it pass, let me know if it reads ok.

Copy link
Contributor Author

@chinandrew chinandrew Dec 1, 2020

Choose a reason for hiding this comment

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

actually i think it's more confusing now since it's the wrong definition, one moment. EDIT: actually maybe its ok?

@krivard
Copy link
Contributor

krivard commented Dec 2, 2020

Ah sorry, this collided with the CHNG-DV signal changes. Would one of you resolve conflicts?

@chinandrew
Copy link
Contributor Author

Ah sorry, this collided with the CHNG-DV signal changes. Would one of you resolve conflicts?

will do

@chinandrew
Copy link
Contributor Author

conflicts resolved

@krivard krivard merged commit f091bdf into main Dec 2, 2020
@krivard krivard deleted the chc-docs branch December 2, 2020 21:50
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.

3 participants