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:
[x] Have you followed the guidelines in our Contributing document?
[x] Have you checked to ensure there aren't other open Pull Requests for the same update/change?
[x] 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
[x] 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
[x] Have you linted your code prior to submission?
[x] 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
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:
[x] Have you followed the guidelines in our Contributing document?
[x] Have you checked to ensure there aren't other open Pull Requests for the same update/change?
[x] Does your PR follow our Code of Conduct?
[x] 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
[x] 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
[x] Have you linted your code prior to submission?
[x] 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