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.

Sign up for GitHub

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

Jump to bottom

docs: docstrings for parsers #1924

Merged
merged 7 commits into from
Feb 16, 2021
Merged

docs: docstrings for parsers #1924

merged 7 commits into from
Feb 16, 2021

Conversation

cristianmtr
Copy link
Contributor

No description provided.

@cristianmtr cristianmtr requested a review from a team as a code owner February 10, 2021 11:37
@jina-bot jina-bot added size/S area/core This issue/PR affects the core codebase labels Feb 10, 2021
@codecov
Copy link

codecov bot commented Feb 10, 2021 •
edited

Codecov Report

Merging #1924 (e56aee0) into master (3b95d78) will increase coverage by 4.57%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1924      +/-   ##
==========================================
+ Coverage   82.00%   86.58%   +4.57%     
==========================================
  Files         148      148              
  Lines        7092     7094       +2     
==========================================
+ Hits         5816     6142     +326     
+ Misses       1276      952     -324
Impacted Files Coverage Δ
jina/parsers/check.py 85.71% <ø> (ø)
jina/parsers/client.py 100.00% <ø> (ø)
jina/parsers/export_api.py 85.71% <ø> (ø)
jina/parsers/flow.py 100.00% <ø> (ø)
jina/parsers/helloworld.py 100.00% <ø> (ø)
jina/parsers/hub/__init__.py 95.00% <ø> (+5.00%) ⬆️
jina/parsers/hub/build.py 100.00% <ø> (ø)
jina/parsers/hub/list.py 100.00% <ø> (ø)
jina/parsers/hub/login.py 100.00% <ø> (ø)
jina/parsers/hub/new.py 100.00% <ø> (ø)
... and 49 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 3b95d78...6dd0e52. Read the comment docs.

@github-actions
Copy link

github-actions bot commented Feb 10, 2021 •
edited

Latency summary

Current PR yields:

  • 😶 index QPS at 998, delta to last 3 avg.: +0%
  • 🐢🐢 query QPS at 14, delta to last 3 avg.: -8%

Breakdown

Version Index QPS Query QPS
current 998 14
1.0.1 1010 14
1.0.0 993 16

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

alexcg1
alexcg1 requested changes Feb 10, 2021
View reviewed changes
jina/parsers/base.py Outdated Show resolved Hide resolved
jina/parsers/export_api.py Outdated Show resolved Hide resolved
jina/parsers/helper.py Outdated Show resolved Hide resolved
jina/parsers/peapods/runtimes/distributed.py Outdated Show resolved Hide resolved
Yongxuanzhang
Yongxuanzhang reviewed Feb 10, 2021
View reviewed changes
jina/parsers/helper.py Show resolved Hide resolved
jina/parsers/helper.py Outdated Show resolved Hide resolved
@cristianmtr @Yongxuanzhang
docs: changes from PR
0db784a 
Co-authored-by: Yongxuanzhang <44033547+Yongxuanzhang@users.noreply.github.com>
alexcg1
alexcg1 previously approved these changes Feb 10, 2021
View reviewed changes
Copy link
Member

@alexcg1 alexcg1 left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Yongxuanzhang
Yongxuanzhang reviewed Feb 10, 2021
View reviewed changes
Copy link
Contributor

@Yongxuanzhang Yongxuanzhang left a comment •
edited

Choose a reason for hiding this comment

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

Miss lots of docstrings for public methods. Not sure if we need to add? If so I can help to add in this PR or in another new PR.
Sorry I didn't find out these in the first review. Just use 'interrogate' to double-check the coverage
@cristianmtr

jina/parsers/ping.py Show resolved Hide resolved
jina/parsers/peapods/runtimes/remote.py Show resolved Hide resolved
jina/parsers/optimizer.py Show resolved Hide resolved
jina/parsers/hub/pushpull.py Show resolved Hide resolved
jina/parsers/hub/new.py Show resolved Hide resolved
jina/parsers/flow.py Show resolved Hide resolved
jina/parsers/export_api.py Show resolved Hide resolved
jina/parsers/client.py Show resolved Hide resolved
jina/parsers/check.py Show resolved Hide resolved
jina/parsers/base.py Show resolved Hide resolved
alexcg1
alexcg1 previously approved these changes Feb 11, 2021
View reviewed changes
@cristianmtr
Copy link
Contributor Author

Miss lots of docstrings for public methods. Not sure if we need to add? If so I can help to add in this PR or in another new PR.
Sorry I didn't find out these in the first review. Just use 'interrogate' to double-check the coverage
@cristianmtr

Adding them now. I think I was running the wrong config of the linter here

@cristianmtr cristianmtr marked this pull request as draft February 15, 2021 08:25
@cristianmtr cristianmtr marked this pull request as ready for review February 15, 2021 09:22
@jina-bot jina-bot added size/M and removed size/S labels Feb 15, 2021
nan-wang
nan-wang requested changes Feb 16, 2021
View reviewed changes
jina/parsers/peapods/pod.py Outdated Show resolved Hide resolved
jina/parsers/__init__.py Outdated Show resolved Hide resolved
jina/parsers/__init__.py Outdated Show resolved Hide resolved
jina/parsers/helper.py Show resolved Hide resolved
jina/parsers/hub/login.py Outdated Show resolved Hide resolved
jina/parsers/hub/list.py Outdated Show resolved Hide resolved
jina/parsers/hub/new.py Outdated Show resolved Hide resolved
nan-wang
nan-wang approved these changes Feb 16, 2021
View reviewed changes
Copy link
Member

@nan-wang nan-wang left a comment

Choose a reason for hiding this comment

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

LGTM👍

@cristianmtr cristianmtr merged commit 2143fa2 into master Feb 16, 2021
@cristianmtr cristianmtr deleted the docs-parsers-docstrings branch February 16, 2021 13:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nan-wang nan-wang nan-wang approved these changes

@maximilianwerk maximilianwerk Awaiting requested review from maximilianwerk

@BastinJafari BastinJafari Awaiting requested review from BastinJafari

@CatStark CatStark Awaiting requested review from CatStark

@Yongxuanzhang Yongxuanzhang Awaiting requested review from Yongxuanzhang

@alexcg1 alexcg1 Awaiting requested review from alexcg1

Assignees
No one assigned
Labels
area/core This issue/PR affects the core codebase size/M
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@cristianmtr @alexcg1 @nan-wang @Yongxuanzhang @jina-bot