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 #276

Merged
merged 3 commits into from Oct 6, 2021
Merged

Add pydocstyle #276

merged 3 commits into from Oct 6, 2021

Conversation

pvk-developer
Copy link
Member

As part of #248 added pydocstyle to validate docstrings with the google style.

Note: ignoring D417 for known issues with the argument definitions : PyCQA/pydocstyle#449

@pvk-developer pvk-developer requested review from a team, amontanez24 and katxiao and removed request for a team October 4, 2021 13:33
Copy link
Contributor

@katxiao katxiao left a comment

Choose a reason for hiding this comment

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

lgtm!

Copy link
Contributor

@amontanez24 amontanez24 left a comment

Choose a reason for hiding this comment

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

This one will likely cause other open PRs to require updating so please coordinate with me before merging. If I merge first and then you merge, there probably won't be conflicts but there will definitely be failed checks.

@codecov-commenter
Copy link

codecov-commenter commented Oct 6, 2021

Codecov Report

Merging #276 (f1c656b) into v0.6.0-dev (11ab02e) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##           v0.6.0-dev     #276   +/-   ##
===========================================
  Coverage       81.69%   81.69%           
===========================================
  Files              10       10           
  Lines             825      825           
===========================================
  Hits              674      674           
  Misses            151      151           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 11ab02e...f1c656b. Read the comment docs.

@pvk-developer pvk-developer merged commit 603d12d into v0.6.0-dev Oct 6, 2021
@pvk-developer pvk-developer deleted the issue_248_add_pydocstyle branch October 6, 2021 21:19
csala pushed a commit that referenced this pull request Oct 13, 2021
* Add pydocstyle for RDT.

* Add pydocstyle for tests

* Add missing docstrings
amontanez24 pushed a commit that referenced this pull request Oct 26, 2021
* Add pydocstyle for RDT.

* Add pydocstyle for tests

* Add missing docstrings
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.

None yet

4 participants