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 docstring and export as xml dim bug #586

Merged
merged 2 commits into from
Nov 5, 2021

Conversation

felixdittrich92
Copy link
Contributor

There was a wrong description in the docstring which results also in the wrong dim order in export_as_xml
now the parser example runs also correct

@codecov
Copy link

codecov bot commented Nov 5, 2021

Codecov Report

Merging #586 (8af56db) into main (c882689) will increase coverage by 0.02%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #586      +/-   ##
==========================================
+ Coverage   96.05%   96.07%   +0.02%     
==========================================
  Files         109      109              
  Lines        4233     4233              
==========================================
+ Hits         4066     4067       +1     
+ Misses        167      166       -1     
Flag Coverage Δ
unittests 96.07% <100.00%> (+0.02%) ⬆️

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

Impacted Files Coverage Δ
doctr/io/elements.py 92.09% <100.00%> (ø)
doctr/utils/visualization.py 92.03% <100.00%> (ø)
...dels/detection/differentiable_binarization/base.py 91.82% <0.00%> (+0.62%) ⬆️

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 c882689...8af56db. Read the comment docs.

Copy link
Contributor

@fg-mindee fg-mindee left a comment

Choose a reason for hiding this comment

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

Thanks would you mind specifying the dimension order in the docstrings of doctr/utils/visualization.py as well? (so that we avoid this to happen again)

@fg-mindee fg-mindee changed the title Fix: docstring and export as xml dim bug docs: Fixed docstring and export as xml dim bug Nov 5, 2021
@fg-mindee fg-mindee self-assigned this Nov 5, 2021
@fg-mindee fg-mindee added topic: documentation Improvements or additions to documentation module: io Related to doctr.io labels Nov 5, 2021
@fg-mindee fg-mindee added this to the 0.4.1 milestone Nov 5, 2021
Copy link
Contributor

@fg-mindee fg-mindee left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks Felix 🙏

@fg-mindee fg-mindee merged commit e96acd1 into mindee:main Nov 5, 2021
@felixdittrich92 felixdittrich92 deleted the xml-bug-fix branch November 5, 2021 10:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
module: io Related to doctr.io topic: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants