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(readme): polish #16

Merged
merged 3 commits into from
Jan 13, 2022
Merged

docs(readme): polish #16

merged 3 commits into from
Jan 13, 2022

Conversation

alexcg1
Copy link
Member

@alexcg1 alexcg1 commented Jan 10, 2022

Basic polishing

@alexcg1 alexcg1 self-assigned this Jan 10, 2022
@alexcg1 alexcg1 requested a review from hanxiao January 10, 2022 09:58
@codecov
Copy link

codecov bot commented Jan 10, 2022

Codecov Report

Merging #16 (cbeb3f6) into main (3573d82) will decrease coverage by 0.13%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #16      +/-   ##
==========================================
- Coverage   82.94%   82.80%   -0.14%     
==========================================
  Files          67       67              
  Lines        3137     3193      +56     
==========================================
+ Hits         2602     2644      +42     
- Misses        535      549      +14     
Flag Coverage Δ
docarray 82.80% <100.00%> (-0.14%) ⬇️

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

Impacted Files Coverage Δ
docarray/array/mixins/plot.py 60.79% <ø> (-8.49%) ⬇️
docarray/__init__.py 100.00% <100.00%> (ø)
docarray/array/document.py 86.86% <100.00%> (+3.06%) ⬆️
docarray/array/mixins/getattr.py 81.81% <100.00%> (-9.10%) ⬇️
docarray/array/mixins/io/binary.py 95.55% <100.00%> (+0.31%) ⬆️
docarray/array/mixins/match.py 92.94% <100.00%> (ø)
docarray/document/mixins/attribute.py 100.00% <100.00%> (ø)
docarray/document/mixins/mesh.py 93.33% <100.00%> (+16.86%) ⬆️
docarray/document/mixins/porting.py 92.59% <100.00%> (+0.92%) ⬆️
docarray/proto/io/ndarray.py 94.78% <100.00%> (+0.09%) ⬆️
... and 6 more

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 f0d222d...cbeb3f6. Read the comment docs.

README.md Outdated Show resolved Hide resolved
Copy link
Member

@hanxiao hanxiao left a comment

Choose a reason for hiding this comment

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

misuse of DocArray

@hanxiao hanxiao merged commit 995dbd3 into main Jan 13, 2022
@hanxiao hanxiao deleted the docs-readme-polish-2022-01 branch January 13, 2022 07:24
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

3 participants