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: Updated README #555

Merged
merged 1 commit into from
Oct 28, 2021
Merged

docs: Updated README #555

merged 1 commit into from
Oct 28, 2021

Conversation

fg-mindee
Copy link
Contributor

This PR clarifies some sentences from the README after some internal feedback.

Any feedback is welcome!

@fg-mindee fg-mindee added topic: documentation Improvements or additions to documentation type: enhancement Improvement labels Oct 28, 2021
@fg-mindee fg-mindee added this to the 0.4.1 milestone Oct 28, 2021
@fg-mindee fg-mindee self-assigned this Oct 28, 2021
@codecov
Copy link

codecov bot commented Oct 28, 2021

Codecov Report

Merging #555 (ee96c59) into main (c356d9e) will increase coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #555      +/-   ##
==========================================
+ Coverage   95.98%   96.00%   +0.02%     
==========================================
  Files         109      109              
  Lines        4180     4180              
==========================================
+ Hits         4012     4013       +1     
+ Misses        168      167       -1     
Flag Coverage Δ
unittests 96.00% <ø> (+0.02%) ⬆️

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

Impacted Files Coverage Δ
doctr/models/builder.py 94.79% <0.00%> (+1.04%) ⬆️

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 c356d9e...ee96c59. 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

@fg-mindee fg-mindee merged commit 943578e into main Oct 28, 2021
@fg-mindee fg-mindee deleted the readme-update branch October 28, 2021 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Improvements or additions to documentation type: enhancement Improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants