openwhisk-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dgr...@apache.org
Subject [incubator-openwhisk-composer] branch master updated: Updated doc to account for feedback on PR #16 (#20)
Date Mon, 11 Feb 2019 15:17:57 GMT
This is an automated email from the ASF dual-hosted git repository.

dgrove pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-openwhisk-composer.git


The following commit(s) were added to refs/heads/master by this push:
     new 8bf8cbf  Updated doc to account for feedback on PR #16 (#20)
8bf8cbf is described below

commit 8bf8cbf2a5791004d15b0df24ef215e5b3d47f88
Author: Olivier Tardieu <tardieu@users.noreply.github.com>
AuthorDate: Mon Feb 11 10:17:53 2019 -0500

    Updated doc to account for feedback on PR #16 (#20)
---
 README.md           |  4 ++--
 docs/COMBINATORS.md | 14 ++++++++++++++
 2 files changed, 16 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 9fa0af1..238b23e 100644
--- a/README.md
+++ b/README.md
@@ -68,7 +68,7 @@ Compositions compose actions using [combinator](docs/COMBINATORS.md) methods.
 These methods implement the typical control-flow constructs of an imperative
 programming language. This example composition composes three actions named
 `authenticate`, `success`, and `failure` using the `composer.if` combinator,
-which implements the usual conditional construct. It take three actions (or
+which implements the usual conditional construct. It takes three actions (or
 compositions) as parameters. It invokes the first one and, depending on the
 result of this invocation, invokes either the second or third action.
 
@@ -168,7 +168,7 @@ invocation time or earlier by means of default parameters or package bindings.
 The required parameter is named `$composer`. It is a dictionary with a `redis`
 field of type dictionary. The `redis` dictionary specifies the `uri` for the
 Redis instance and optionally a certificate as a base64-encoded string to enable
-tls connections. Hence, the input parameter object for our order-processing
+TLS connections. Hence, the input parameter object for our order-processing
 example should be:
 ```json
 {
diff --git a/docs/COMBINATORS.md b/docs/COMBINATORS.md
index d3d9cd2..9a157d2 100644
--- a/docs/COMBINATORS.md
+++ b/docs/COMBINATORS.md
@@ -451,6 +451,13 @@ every branch in the composition. The output parameter object for the
composition
 has a single field named `value` of type array. The elements of the array are
 the output parameter objects for the branches in order.
 
+Error results from the branches are included in the array of results like normal
+results. In particular, an error result from a branch does not interrupt the
+parallel execution of the other branches. Moreover, since errors results are
+nested inside an output parameter object with a single `value` field, an error
+from a branch does not trigger the execution of the current error handler. The
+caller should walk the array and decide if and how to handle errors.
+
 The `composer.let` variables in scope at the `parallel` combinator are in scope
 in the branches. But each branch has its own copy of the execution context.
 Variable mutations in one branch are not reflected in other branches or in the
@@ -475,6 +482,13 @@ output parameter object for the composition has a single field named
`value` of
 type array. The elements of the array are the output parameter objects for the
 branches in order.
 
+Error results from the branches are included in the array of results like normal
+results. In particular, an error result from a branch does not interrupt the
+parallel execution of the other branches. Moreover, since errors results are
+nested inside an output parameter object with a single `value` field, an error
+from a branch does not trigger the execution of the current error handler. The
+caller should walk the array and decide if and how to handle errors.
+
 The `composer.let` variables in scope at the `map` combinator are in scope in
 the branches. But each branch has its own copy of the execution context.
 Variable mutations in one branch are not reflected in other branches or in the


Mime
View raw message