Skip to content

Update usafacts docstrings to pass pydocstyle #377

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
Merged
merged 2 commits into from
Nov 5, 2020
Merged

Update usafacts docstrings to pass pydocstyle #377

merged 2 commits into from
Nov 5, 2020

Conversation

@chinandrew
Copy link
Contributor

@chinandrew chinandrew commented Oct 27, 2020

Summary of changes:

  • Update docstrings so they pass the pydocstyle linter, which checks against most of PEP257
  • geomapping functions are excluded since they'll be removed once the refactor goes through.

@chinandrew chinandrew mentioned this pull request Oct 27, 2020
Closed
@chinandrew chinandrew added the documentation Improvements or additions to documentation label Oct 27, 2020
@krivard krivard requested a review from jingjtang October 28, 2020 13:06
jingjtang
jingjtang previously approved these changes Oct 28, 2020
View reviewed changes
@krivard krivard changed the base branch from main to deploy-usafacts October 28, 2020 14:04
@krivard krivard dismissed jingjtang’s stale review October 28, 2020 14:04

The base branch was changed.

krivard
krivard previously approved these changes Oct 28, 2020
View reviewed changes
Copy link
Contributor

@krivard krivard left a comment

Choose a reason for hiding this comment

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

Changes to USAFacts docstrings are good; changes to geomapper are blocked on #316.

@krivard krivard added the blocked This task is waiting for completion of another task label Oct 28, 2020
@chinandrew chinandrew changed the base branch from deploy-usafacts to main November 5, 2020 17:29
@chinandrew
Copy link
Contributor Author

chinandrew commented Nov 5, 2020

@krivard Is the base branch supposed to be main or deploy-usafacts?

@krivard
Copy link
Contributor

krivard commented Nov 5, 2020

We're going with main for the moment to keep folks unblocked.

@krivard krivard merged commit 3780c5e into main Nov 5, 2020
@krivard krivard deleted the usafacts-docs branch November 5, 2020 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jingjtang jingjtang jingjtang left review comments

+1 more reviewer

@krivard krivard krivard left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

blocked This task is waiting for completion of another task documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@chinandrew @krivard @jingjtang