docs: add explain on return #4351
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
JoanFM
reviewed
Feb 16, 2022
| @@ -147,7 +147,7 @@ class MyExecutor(Executor): | |||
| @requests | |||
| async def foo( | |||
| self, docs: DocumentArray, parameters: Dict, docs_matrix: List[DocumentArray] | |||
| ) -> Optional[Union[DocumentArray, Dict]]: | |||
| ) -> Union[DocumentArray, Dict, None]: | |||
There was a problem hiding this comment.
Suggested change
| ) -> Union[DocumentArray, Dict, None]: | |
| ) -> Optional[Union[DocumentArray, Dict]]: |
This is by definition Optional and is much more standard
There was a problem hiding this comment.
actually it is the oppsite, if you look typing, pydantic or dataclass, they all get translate Optional into Union[..., None]
There was a problem hiding this comment.
Here this usage can better map to what I later said, "there are 3 ways of returning", Union[1,2,3] -> 3 ways
Latency summaryCurrent PR yields:
Breakdown
Backed by latency-tracking. Further commits will update this comment. |
Co-authored-by: Johannes Messner <44071807+JohannesMessner@users.noreply.github.com>
|
📝 Docs are deployed on https://fix-docs-return--jina-docs.netlify.app 🎉 |
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.
Pull Request Title
Description
Please describe what your PR is doing and why. Are there any parts which need extra attention during review? Are there any dependencies from other PRs or projcts? Is this a breaking change?
Is this PR ready or work in progress (WIP)? Ready means it can be reviewed and merged from the author's perspective. If the PR is WIP: Make it a draft PR and state open questions and TODO items.
Closes # (issue)