Skip to content

Feat docs improvment#396

Merged
hanxiao merged 1 commit into
mainfrom
feat-docs-improvment
Jun 20, 2022
Merged

Feat docs improvment#396
hanxiao merged 1 commit into
mainfrom
feat-docs-improvment

Conversation

@samsja

@samsja samsja commented Jun 9, 2022

Copy link
Copy Markdown
Member

Goals:

POC of making a better API reference page. Will be implemented in core as well
work initiated with @davidbp @JohannesMessner

  • ...
  • ...
  • check and update documentation, if required. See guide

@codecov

codecov Bot commented Jun 9, 2022

Copy link
Copy Markdown

Codecov Report

Merging #396 (e1cac01) into main (d559752) will increase coverage by 1.70%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #396      +/-   ##
==========================================
+ Coverage   84.77%   86.47%   +1.70%     
==========================================
  Files         134      134              
  Lines        6358     6367       +9     
==========================================
+ Hits         5390     5506     +116     
+ Misses        968      861     -107     
Flag Coverage Δ
docarray 86.47% <100.00%> (+1.70%) ⬆️

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

Impacted Files Coverage Δ
docarray/__init__.py 75.00% <100.00%> (ø)
docarray/array/storage/annlite/backend.py 95.58% <0.00%> (ø)
docarray/array/storage/weaviate/backend.py 87.59% <0.00%> (+0.09%) ⬆️
docarray/helper.py 81.73% <0.00%> (+0.33%) ⬆️
docarray/array/storage/memory/find.py 91.22% <0.00%> (+1.75%) ⬆️
docarray/array/storage/elastic/backend.py 94.39% <0.00%> (+1.86%) ⬆️
docarray/array/mixins/getattr.py 81.81% <0.00%> (+3.03%) ⬆️
docarray/array/storage/base/backend.py 82.60% <0.00%> (+3.66%) ⬆️
docarray/array/storage/elastic/getsetdel.py 100.00% <0.00%> (+4.65%) ⬆️
docarray/array/mixins/find.py 87.35% <0.00%> (+5.74%) ⬆️
... and 5 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 ae4d63b...e1cac01. Read the comment docs.

@github-actions

Copy link
Copy Markdown

📝 Docs are deployed on https://ft-feat-docs-improvment--jina-docs.netlify.app 🎉

@hanxiao
hanxiao merged commit ed30272 into main Jun 20, 2022
@hanxiao
hanxiao deleted the feat-docs-improvment branch June 20, 2022 21:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants