Skip to content
This repository has been archived by the owner. It is now read-only.

Add pydocstyle linter #289

merged 1 commit into from Mar 4, 2019

Add pydocstyle linter #289

merged 1 commit into from Mar 4, 2019


Copy link

@c-w c-w commented Mar 4, 2019

We have an ongoing effort to improve the quality of our documentation. As such, this pull request adds pydocstyle as a linter to ensure that our docstrings have a consistent formatting and tone.

All Submissions:

  • Have you followed the guidelines in our Contributing document?

  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?

  • Does your PR follow our Code of Conduct?

  • Have you added an explanation of what your changes do and why you'd like us to include them?

  • Does each method or function "do one thing well"? Reviewers may recommend methods be split up for maintainability and testability. N/A: linter

  • Is this code designed to be testable? N/A: linter

  • Is the code documented well? N/A: linter

  • Does your submission pass existing tests (or update existing tests with documentation regarding the change)?

  • Have you added tests to cover your changes? N/A: linter

  • Have you linted your code prior to submission?

  • Have you updated the documentation and README?

  • Is PII treated correctly? In particular, make sure the code is not logging objects or strings that might contain PII (e.g. request headers). N/A: linter

  • Have secrets been stripped before committing? N/A: linter

@c-w c-w requested a review from sayar Mar 4, 2019
sayar approved these changes Mar 4, 2019
@c-w c-w merged commit be2749b into master Mar 4, 2019
6 checks passed
@c-w c-w deleted the add-pydocstyle-linter branch Mar 4, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
None yet
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants