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

Add pydocstyle to PR checks #34

Merged
merged 4 commits into from
Nov 3, 2021
Merged

Add pydocstyle to PR checks #34

merged 4 commits into from
Nov 3, 2021

Conversation

nawatts
Copy link
Contributor

@nawatts nawatts commented Nov 3, 2021

pydocstyle is currently configured as a pre-commit hook. However, it would be good to run it on pull requests as well since some contributors may not have pre-commit hooks set up.

This PR...

  • Adds pydocstyle to requirements.in/requirements.txt so that we can pin the version used in PR checks and use the same version in PR checks as in pre-commit hooks.
  • Moves pydocstyle configuration to pyproject.toml so that PR checks and pre-commit hooks use the same configuration. This required updating pydocstyle.
  • Removes the blanket ignore of rule D103 (public functions must have docstrings) and replaces it with specific ignore comments on main functions in scripts.
  • Adds pydocstyle to the CI workflow run on PRs.

Related to #21

@nawatts nawatts requested a review from klaricch November 3, 2021 19:25
Copy link
Collaborator

@klaricch klaricch left a comment

Choose a reason for hiding this comment

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

Thanks Nick!

@nawatts nawatts merged commit bd617c8 into main Nov 3, 2021
@nawatts nawatts deleted the pydocstyle-check branch November 3, 2021 20:22
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