Add Pydocstyle #325
Merged
Add Pydocstyle #325
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #325 +/- ##
==========================================
+ Coverage 70.27% 70.55% +0.28%
==========================================
Files 41 42 +1
Lines 4744 4786 +42
==========================================
+ Hits 3334 3377 +43
+ Misses 1410 1409 -1
Flags with carried forward coverage won't be shown. Click here to find out more.
|
Javagedes
force-pushed
the
feature/pydocstyle
branch
13 times, most recently
from
dd13068
to
9042dd5
Compare
Adds Pydocstyle linting requirements using the google convention by adding this linting to the PR gate. Updates developing.md documentation and adds Pydocstyle linting to the vscode settings.
Updates all files to be in compliance with the google pydocstyle convention.
Javagedes
force-pushed
the
feature/pydocstyle
branch
from
9042dd5
to
9844fb7
Compare
spbrogan
approved these changes
Nov 2, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds PyDocStyle (google convention) to the PR Gates to enforce proper documentation in preparation for automatic documentation generation.
Brings all documentation in this repo in line with this convention.
This PR will be a REBASE&FF. The first commit adds the infrastructure for pydocstyle (pipelines, vscode settings, config settings, etc) while the second commit actually makes the compliance changes in this repo.