8000
docs(helper): add missing helper docstrings #1927
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #1927 +/- ##
==========================================
+ Coverage 86.50% 86.52% +0.01%
==========================================
Files 148 148
Lines 7042 7056 +14
==========================================
+ Hits 6092 6105 +13
- Misses 950 951 +1
Continue to review full report at Codecov.
|
Latency summaryCurrent PR yields:
Breakdown
Backed by latency-tracking. Further commits will update this comment. |
maximilianwerk
requested changes
Feb 12, 2021
| @@ -904,7 +948,10 @@ def run_async(func, *args, **kwargs): | |||
| """ | |||
|
|
|||
| class RunThread(threading.Thread): | |||
| """Create a running thread when in Jupyter notebook.""" | |||
There was a problem hiding this comment.
This class is private to the function. Having docstrings is OK, but I'd still rename it to _RunThread in order to highlight, that it is private.
jina/helper.py
Outdated
| def run(self): | ||
| """Run function for thread.""" |
There was a problem hiding this comment.
Suggested change
| """Run function for thread.""" | |
| """Runs given `func` asynchronously.""" |
jina/helper.py
Outdated
| @@ -743,11 +757,41 @@ def typename(obj): | |||
|
|
|||
|
|
|||
| def rsetattr(obj, attr: str, val): | |||
There was a problem hiding this comment.
rsetattr and rgetattr are not used anywhere in the codebase anymore. Let's remove them.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.