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

docs: Added minimal docstring sanity check #686

Merged
merged 6 commits into from
Dec 9, 2021
Merged

Conversation

fg-mindee
Copy link
Contributor

This PR introduces the following modifications:

  • added config for pydocstyle
  • added deps in setup.py, updated CONTRIBUTING & Makefile
  • added a CI job to run pydocstyle
  • fixed docstrings that were posing problems

Any feedback is welcome!

@fg-mindee fg-mindee added topic: documentation Improvements or additions to documentation type: enhancement Improvement topic: build Related to dependencies and build topic: ci Related to CI labels Dec 9, 2021
@fg-mindee fg-mindee added this to the 0.5.0 milestone Dec 9, 2021
@fg-mindee fg-mindee self-assigned this Dec 9, 2021
@codecov
Copy link

codecov bot commented Dec 9, 2021

Codecov Report

Merging #686 (c591119) into main (c2af6e9) will increase coverage by 0.08%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #686      +/-   ##
==========================================
+ Coverage   96.27%   96.36%   +0.08%     
==========================================
  Files         117      117              
  Lines        4540     4540              
==========================================
+ Hits         4371     4375       +4     
+ Misses        169      165       -4     
Flag Coverage Δ
unittests 96.36% <ø> (+0.08%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
doctr/models/recognition/master/pytorch.py 95.58% <ø> (ø)
doctr/models/recognition/master/tensorflow.py 96.50% <ø> (ø)
doctr/utils/fonts.py 92.85% <ø> (ø)
doctr/utils/metrics.py 97.40% <ø> (ø)
doctr/utils/visualization.py 92.03% <ø> (ø)
doctr/models/detection/linknet/base.py 83.16% <0.00%> (-1.99%) ⬇️
...dels/detection/differentiable_binarization/base.py 92.77% <0.00%> (+0.55%) ⬆️
doctr/models/builder.py 99.12% <0.00%> (+2.63%) ⬆️
doctr/models/recognition/predictor/pytorch.py 96.96% <0.00%> (+6.06%) ⬆️

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 c2af6e9...c591119. Read the comment docs.

Copy link
Collaborator

@charlesmindee charlesmindee left a comment

Choose a reason for hiding this comment

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

Thanks for that!

@fg-mindee fg-mindee merged commit 9c45ba6 into main Dec 9, 2021
@fg-mindee fg-mindee deleted the docstring-check branch December 9, 2021 13:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: build Related to dependencies and build topic: ci Related to CI topic: documentation Improvements or additions to documentation type: enhancement Improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants