Skip to content

Conversation

nawatts
Copy link
Contributor

@nawatts nawatts commented Apr 26, 2021

Currently, PR checks run pydocstyle on files in the gnomad directory.

- name: Check docstrings
run: pydocstyle gnomad

Pre-commit hooks, however, run it on all Python files that changed in the commit.

- repo: https://github.com/pycqa/pydocstyle
rev: 6.0.0
hooks:
- id: pydocstyle

Thus, it's currently possible for a change to pass PR checks, get merged, and then cause pre-commit hooks to fail when it is pulled locally. This change brings PR checks and pre-commit hooks closer in line by running pydocstyle on tests in PR checks.

@nawatts nawatts requested review from a team and ch-kr and removed request for a team April 26, 2021 18:44
Copy link
Contributor

@ch-kr ch-kr left a comment

Choose a reason for hiding this comment

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

small question

Copy link
Contributor

@ch-kr ch-kr left a comment

Choose a reason for hiding this comment

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

lgtm!

@nawatts nawatts merged commit 156472b into master Apr 28, 2021
@nawatts nawatts deleted the run-pydocstyle-on-tests branch April 28, 2021 20:10
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