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 reference check while build docs #1600

Merged
merged 5 commits into from
Jan 6, 2021
Merged

Conversation

bwanglzu
Copy link
Member

@bwanglzu bwanglzu commented Jan 5, 2021

Add cross-reference checker for sphinx.

with this PR, several options have been offered to make docstring more robust:

  1. make html will show warnings if the internal referenced link is incorrect.
  2. make linkcheck same as above, without generating html pages.
  3. make coverage check the docstring coverage.

Some basic statistics:

broken links: Found 2724 broken links, ~2550 were broken links in CHANGELOG.md.
coverage: ~40 undocumented methods & classes.
warnings: 2721 warnings, mostly are class or method reference not found.

@bwanglzu bwanglzu requested a review from a team as a code owner January 5, 2021 20:56
@jina-bot jina-bot added size/XS area/docs This issue/PR affects the docs labels Jan 5, 2021
@github-actions
Copy link

github-actions bot commented Jan 5, 2021

Latency summary

Current PR yields:

  • 😶 index QPS at 1670, delta to last 3 avg.: -2%
  • 😶 query QPS at 32, delta to last 3 avg.: -2%

Breakdown

Version Index QPS Query QPS
current 1670 32
0.9.2 1717 32
0.9.1 1684 32
0.8.22 1747 32

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

@bwanglzu bwanglzu marked this pull request as draft January 5, 2021 21:41
@codecov
Copy link

codecov bot commented Jan 5, 2021

Codecov Report

Merging #1600 (bbcb4f0) into master (692c2d9) will increase coverage by 0.92%.
The diff coverage is 61.53%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1600      +/-   ##
==========================================
+ Coverage   83.92%   84.84%   +0.92%     
==========================================
  Files         128      128              
  Lines        6674     6732      +58     
==========================================
+ Hits         5601     5712     +111     
+ Misses       1073     1020      -53     
Impacted Files Coverage Δ
jina/peapods/runtimes/jinad/__init__.py 48.38% <44.44%> (ø)
jina/peapods/runtimes/jinad/api.py 54.66% <100.00%> (-0.31%) ⬇️
jina/logging/profile.py 69.84% <0.00%> (-0.56%) ⬇️
jina/drivers/craft.py 100.00% <0.00%> (ø)
jina/types/ndarray/generic.py 100.00% <0.00%> (ø)
jina/drivers/encode.py 94.91% <0.00%> (+0.08%) ⬆️
jina/enums.py 96.59% <0.00%> (+0.09%) ⬆️
jina/jaml/__init__.py 95.93% <0.00%> (+0.09%) ⬆️
jina/flow/base.py 86.58% <0.00%> (+0.10%) ⬆️
jina/clients/helper.py 94.00% <0.00%> (+0.12%) ⬆️
... and 15 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 96e28fe...054f05b. Read the comment docs.

@bwanglzu bwanglzu marked this pull request as ready for review January 5, 2021 22:13
@nan-wang nan-wang merged commit 848fbcc into master Jan 6, 2021
@nan-wang nan-wang deleted the docs-add-scanner-config branch January 6, 2021 02:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs This issue/PR affects the docs size/XS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants