docs: clarify __return__ behavior in parameters (#5179)

jina-ai · Sep 20, 2022 · 22330fc · 22330fc
1 parent 243639d
commit 22330fc
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/docs/fundamentals/executor/executor-methods.md b/docs/fundamentals/executor/executor-methods.md
@@ -346,8 +346,8 @@ class DummyExecutor(Executor):
 Every Executor method can `return` in 3 ways: 
 
 - If you return a `DocumentArray` object, then it will be sent over to the next Executor.
-- If you return `None` or if you don't have a `return` in your method, then the original `doc` object (potentially mutated by your function) will be sent over to the next Executor.
-- If you return a `dict` object, then it will be considered as a result and passed on behind `parameters['__results__']`. The original `doc` object (potentially mutated by your function) will be sent over to the next Executor.
+- If you return `None` or if you don't have a `return` in your method, then the original `docs` object (potentially mutated by your function) will be sent over to the next Executor.
+- If you return a `dict` object, then it will be considered as a result and returned on `parameters['__results__']` to the client. `__results__` key will not be available in subsequent Executors. The original `docs` object (potentially mutated by your function) will be sent over to the next Executor.
 
 
 ```python