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: ignore noqa in docstring #1955

Merged
merged 1 commit into from Feb 17, 2021
Merged

docs: ignore noqa in docstring #1955

merged 1 commit into from Feb 17, 2021

Conversation

bwanglzu
Copy link
Member

@bwanglzu bwanglzu commented Feb 16, 2021

problem: noqa has been added as a part of docstring, and sphinx can not ignore it.

workaround found here, adding two dots before noqa should ignore it.

@bwanglzu bwanglzu linked an issue Feb 16, 2021 that may be closed by this pull request
@codecov
Copy link

codecov bot commented Feb 16, 2021

Codecov Report

Merging #1955 (c5afd96) into master (3e3949a) will increase coverage by 1.12%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1955      +/-   ##
==========================================
+ Coverage   85.45%   86.58%   +1.12%     
==========================================
  Files         148      148              
  Lines        7094     7094              
==========================================
+ Hits         6062     6142      +80     
+ Misses       1032      952      -80     
Impacted Files Coverage Δ
jina/drivers/control.py 95.08% <ø> (ø)
jina/drivers/encode.py 94.20% <ø> (+2.89%) ⬆️
jina/drivers/evaluate.py 98.27% <ø> (ø)
jina/drivers/predict.py 92.59% <ø> (+53.70%) ⬆️
jina/drivers/querylang/select.py 89.65% <ø> (+17.24%) ⬆️
jina/flow/base.py 89.84% <ø> (ø)
jina/flow/builder.py 73.91% <ø> (ø)
jina/jaml/helper.py 93.89% <ø> (ø)
jina/jaml/parsers/base.py 71.42% <ø> (ø)
jina/parsers/helper.py 50.66% <ø> (ø)
... and 10 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 3e3949a...c5afd96. Read the comment docs.

@bwanglzu bwanglzu self-assigned this Feb 16, 2021
@bwanglzu bwanglzu marked this pull request as ready for review February 16, 2021 15:59
@bwanglzu bwanglzu requested a review from a team as a code owner February 16, 2021 15:59
@cristianmtr
Copy link
Contributor

problem: noqa has been added as a part of docstring, and sphinx can not ignore it.

workaround found here, adding two dots before noqa should ignore it.

Ah cool that you fixed it. Can you make a note of it in the docstrings guide and link to this PR as example?

@github-actions
Copy link

Latency summary

Current PR yields:

  • 😶 index QPS at 1149, delta to last 3 avg.: +0%
  • 🐢🐢 query QPS at 19, delta to last 3 avg.: -7%

Breakdown

Version Index QPS Query QPS
current 1149 19
1.0.1 1159 19
1.0.0 1131 21

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

@bwanglzu bwanglzu merged commit 9a844b6 into master Feb 17, 2021
@bwanglzu bwanglzu deleted the docs-fix-noqa branch February 17, 2021 09:45
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.

Sphinx configuration failed to ignore lint exceptions
4 participants