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: Fixed typo in the docstrings of metrics #664

Merged
merged 1 commit into from
Dec 1, 2021
Merged

Conversation

fg-mindee
Copy link
Contributor

This PR simply fixes a typo in the math formula of the metric expression in docstrings.

Any feedback is welcome!

@fg-mindee fg-mindee added type: bug Something isn't working topic: documentation Improvements or additions to documentation labels Dec 1, 2021
@fg-mindee fg-mindee added this to the 0.5.0 milestone Dec 1, 2021
@fg-mindee fg-mindee self-assigned this Dec 1, 2021
@codecov
Copy link

codecov bot commented Dec 1, 2021

Codecov Report

Merging #664 (73d1e7d) into main (e14645a) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #664   +/-   ##
=======================================
  Coverage   96.15%   96.15%           
=======================================
  Files         114      114           
  Lines        4447     4447           
=======================================
  Hits         4276     4276           
  Misses        171      171           
Flag Coverage Δ
unittests 96.15% <ø> (ø)

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

Impacted Files Coverage Δ
doctr/utils/metrics.py 97.40% <ø> (ø)

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 e14645a...73d1e7d. 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 1fa1ef5 into main Dec 1, 2021
@fg-mindee fg-mindee deleted the metric-doc branch December 1, 2021 15:17
@fg-mindee fg-mindee added the module: utils Related to doctr.utils label Dec 31, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
module: utils Related to doctr.utils topic: documentation Improvements or additions to documentation type: bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants