docs: docstring for types/score #1903
Merged
Conversation
This file contains 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
jina-bot
added
size/S
area/core
JoanFM
reviewed
Feb 8, 2021
| view (i.e. weak reference) from it or a deep copy from it. | ||
| :param kwargs: other parameters to be set | ||
| """ | ||
| """Set constructor.""" |
There was a problem hiding this comment.
It has to be an imperative sentence. I don't know what else could be better wording; "define"?
Codecov Report
@@ Coverage Diff @@
## master #1903 +/- ##
==========================================
- Coverage 84.39% 82.05% -2.34%
==========================================
Files 148 148
Lines 7062 7062
==========================================
- Hits 5960 5795 -165
- Misses 1102 1267 +165
Continue to review full report at Codecov.
|
Latency summaryCurrent PR yields:
Breakdown
Backed by latency-tracking. Further commits will update this comment. |
| return self._pb_body.ref_id | ||
|
|
||
| @ref_id.setter | ||
| def ref_id(self, val: str): | ||
| self._pb_body.ref_id = val | ||
|
|
||
| def set_attrs(self, **kwargs): | ||
| """Bulk update Document fields with key-value specified in kwargs | ||
| """Udate Document fields with key-value specified in kwargs. |
There was a problem hiding this comment.
'Udate' should be' Update' ?
| :param copy: When ``score`` is given as a :class:`NamedScoreProto` object, build a | ||
| view (i.e. weak reference) from it or a deep copy from it. | ||
| :type copy: bool | ||
| :param kwargs: Other parameters to be set |
There was a problem hiding this comment.
Missing a period at the end?
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.