English fixes to the doc.
@@ -9,8 +9,8 @@ To be correctly processed by this executor, an Action should provide two entries
the path to a script on the local filesystem of the executor process, and all the arguments
to be passed to the script itself.
-The script path is identified by the payload key __script__; it is important to verify that the
-executor has read and execute rights at that path.
+The script path is identified by the payload key __script__. It is important to verify that the
+executor has both read and execute rights at that path.
The script arguments are identified by the payload key __args__;
if present, they are passed as command line arguments when the script
@@ -31,12 +31,14 @@ An example of a valid Action is:
```
In this case the executor will launch the script _my_script.sh_ with the arguments
-"tornado" and "rust". Consequently, the resulting command executed will be:
+"tornado" and "rust". Consequently, the resulting command will be:
```bash
./usr/script/my_script.sh tornado rust
```
-## Other ways of passing the arguments
+
+## Other Ways of Passing Arguments
+
There are different ways to pass the arguments for a script:
- Passing arguments as a String:
@@ -51,7 +53,7 @@ There are different ways to pass the arguments for a script:
}
```
- If args is a String, the entire String is
+ If __args__ is a String, the entire String is
appended to the script. In this case the resulting command will be:
```bash
@@ -75,7 +77,7 @@ There are different ways to pass the arguments for a script:
}
```
- Here we are passing arguments in an array; they are passed to the script in the exact order
+ Here the argument's array elements are passed to the script in the exact order
they are declared. In this case the resulting command will be:
```bash
@@ -97,8 +99,8 @@ There are different ways to pass the arguments for a script:
}
```
- When arguments are passed in a map, each entry in the map is considered a pair of
- option key and option value. Each pair is passed to the script using the default style to
+ When arguments are passed in a map, each entry in the map is considered to be a
+ (option key, option value) pair. Each pair is passed to the script using the default style to
pass options to a Unix executable which is _--key_ followed by the _value_.
Consequently, the resulting command will be:
@@ -106,15 +108,15 @@ There are different ways to pass the arguments for a script:
./usr/script/my_script.sh --arg_one tornado --arg_two rust
```
- Please note that ordering is not granted in this case; so the resulting command line
- could also be:
+ Please note that ordering is not guaranteed to be preserved in this case, so the resulting
+ command line could also be:
```bash
./usr/script/my_script.sh --arg_two rust --arg_one tornado
```
- If the order of the arguments matters, you should pass them using the String or
- the Array based approach.
+ Thus if the order of the arguments matters, you should pass them using either the
+ string- or the array-based approach.
- Passing no arguments:
@@ -127,8 +129,8 @@ There are different ways to pass the arguments for a script:
}
```
- Since the arguments are not mandatory, they can be omitted.
- In this case the resulting command will be a simple:
+ Since arguments are not mandatory, they can be omitted.
+ In this case the resulting command will simply be:
```bash
./usr/script/my_script.sh
