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: add missing docstrings for core #2040

Merged
merged 5 commits into from Feb 25, 2021
Merged

Conversation

Yongxuanzhang
Copy link
Contributor

@Yongxuanzhang Yongxuanzhang commented Feb 24, 2021

Improve the docstring coverage in Jina core to 100% 🥳 .

@codecov
Copy link

codecov bot commented Feb 24, 2021

Codecov Report

Merging #2040 (ac7f7de) into master (1f4ded9) will decrease coverage by 15.67%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##           master    #2040       +/-   ##
===========================================
- Coverage   88.75%   73.08%   -15.68%     
===========================================
  Files         200      181       -19     
  Lines       10933    10372      -561     
===========================================
- Hits         9704     7580     -2124     
- Misses       1229     2792     +1563     
Flag Coverage Δ
daemon ?
jina 73.08% <ø> (-16.12%) ⬇️

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

Impacted Files Coverage Δ
jina/clients/base.py 71.66% <ø> (-9.17%) ⬇️
jina/executors/indexers/keyvalue.py 98.70% <ø> (ø)
jina/flow/base.py 92.38% <ø> (ø)
jina/helloworld/chatbot/__init__.py 89.28% <ø> (ø)
jina/helloworld/helper.py 90.62% <ø> (ø)
jina/helloworld/multimodal/__init__.py 90.90% <ø> (ø)
jina/logging/logger.py 77.16% <ø> (-5.52%) ⬇️
jina/logging/profile.py 70.07% <ø> (-25.20%) ⬇️
jina/optimizers/__init__.py 0.00% <ø> (-94.40%) ⬇️
jina/optimizers/discovery.py 0.00% <ø> (-80.27%) ⬇️
... and 124 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 1f4ded9...f9b57f5. Read the comment docs.

@github-actions
Copy link

github-actions bot commented Feb 24, 2021

Latency summary

Current PR yields:

  • 😶 index QPS at 910, delta to last 3 avg.: +0%
  • 🐢🐢 query QPS at 12, delta to last 3 avg.: -11%

Breakdown

Version Index QPS Query QPS
current 910 12
1.0.4 918 13
1.0.3 904 13

Backed by latency-tracking. Further commits will update this comment.

@Yongxuanzhang Yongxuanzhang marked this pull request as ready for review February 24, 2021 22:19
@Yongxuanzhang Yongxuanzhang requested a review from a team as a code owner February 24, 2021 22:19
@hanxiao hanxiao merged commit 974edbb into master Feb 25, 2021
@hanxiao hanxiao deleted the docs-add-missing-docstrings branch February 25, 2021 06:29
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.

None yet

3 participants