Skip to content
This repository was archived by the owner on Jan 17, 2025. It is now read-only.

Commit 5eb3316

Browse files
jbamptonreggeenr
authored andcommitted
chore: fix grammar and spelling (#78)
1 parent 856cc5b commit 5eb3316

File tree

5 files changed

+14
-14
lines changed

5 files changed

+14
-14
lines changed

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
# Contributing to Apache OpenWhisk
2323

24-
Anyone can contribute to the OpenWhisk project and we welcome your contributions.
24+
Anyone can contribute to the OpenWhisk project, and we welcome your contributions.
2525

2626
There are multiple ways to contribute: report bugs, improve the docs, and
2727
contribute code, but you must follow these prerequisites and guidelines:
@@ -50,7 +50,7 @@ Please raise any bug reports or enhancement requests on the respective project r
5050
list to see if your issue has already been raised.
5151

5252
A good bug report is one that make it easy for us to understand what you were trying to do and what went wrong.
53-
Provide as much context as possible so we can try to recreate the issue.
53+
Provide as much context as possible, so we can try to recreate the issue.
5454

5555
A good enhancement request comes with an explanation of what you are trying to do and how that enhancement would help you.
5656

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,12 @@ Node Package Manager:
4949
```
5050
npm install -g openwhisk-composer
5151
```
52-
We recommend to install the package globally (with `-g` option) if you intend to
52+
We recommend installing the package globally (with `-g` option) if you intend to
5353
use the `compose` and `deploy` commands to compile and deploy compositions.
5454

5555
## Defining a composition
5656

57-
A composition is typically defined by means of a Javascript expression as
57+
A composition is typically defined by means of a JavaScript expression as
5858
illustrated in [samples/demo.js](samples/demo.js):
5959
```javascript
6060
const composer = require('openwhisk-composer')
@@ -73,7 +73,7 @@ compositions) as parameters. It invokes the first one and, depending on the
7373
result of this invocation, invokes either the second or third action.
7474

7575
This composition includes the definitions of the three composed actions. If the
76-
actions are defined and deployed elsewhere, the composition code can be shorten
76+
actions are defined and deployed elsewhere, the composition code can be shortened
7777
to:
7878
```javascript
7979
composer.if('authenticate', 'success', 'failure')

docs/COMBINATORS.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The `composer` module offers a number of combinators to define compositions:
2929
| [`dynamic`](#dynamic) | dynamic invocation | `composer.dynamic()`
3030
| [`empty`](#empty) | empty sequence | `composer.empty()`
3131
| [`finally`](#finally) | finalization | `composer.finally('tryThis', 'doThatAlways')` |
32-
| [`function`](#function) | Javascript function | `composer.function(({ x, y }) => ({ product: x * y }))` |
32+
| [`function`](#function) | JavaScript function | `composer.function(({ x, y }) => ({ product: x * y }))` |
3333
| [`if` and `if_nosave`](#if) | conditional | `composer.if('authenticate', 'success', 'failure')` |
3434
| [`let`](#let) | variable declarations | `composer.let({ count: 3, message: 'hello' }, ...)` |
3535
| [`literal` or `value`](#literal) | constant value | `composer.literal({ message: 'Hello, World!' })` |
@@ -46,7 +46,7 @@ The `composer` module offers a number of combinators to define compositions:
4646
| [`while` and `while_nosave`](#while) | loop | `composer.while('notEnough', 'doMore')` |
4747

4848
The `action`, `function`, and `literal` combinators construct compositions
49-
respectively from OpenWhisk actions, Javascript functions, and constant values.
49+
respectively from OpenWhisk actions, JavaScript functions, and constant values.
5050
The other combinators combine existing compositions to produce new compositions.
5151

5252
## Shorthands
@@ -110,7 +110,7 @@ composer.action('hello', { filename: 'hello.js' })
110110
composer.action('helloAndBye', { sequence: ['hello', 'bye'] })
111111
```
112112
The action may be defined by providing the code for the action as a string, as a
113-
Javascript function, or as a file name. Alternatively, a sequence action may be
113+
JavaScript function, or as a file name. Alternatively, a sequence action may be
114114
defined by providing the list of sequenced actions. The code (specified as a
115115
string) may be annotated with the kind of the action runtime.
116116

@@ -128,7 +128,7 @@ The `limits` object optionally specifies any combination of:
128128

129129
### Environment capture in actions
130130

131-
Javascript functions used to define actions cannot capture any part of their
131+
JavaScript functions used to define actions cannot capture any part of their
132132
declaration environment. The following code is not correct as the declaration of
133133
`name` would not be available at invocation time:
134134
```javascript
@@ -144,7 +144,7 @@ composer.action('hello', { action: `function main() { return { message: 'Hello '
144144

145145
## Function
146146

147-
`composer.function(fun)` is a composition with a single Javascript function
147+
`composer.function(fun)` is a composition with a single JavaScript function
148148
_fun_. It applies the specified function to the input parameter object for the
149149
composition.
150150
- If the function returns a value of type `function`, the composition returns
@@ -313,7 +313,7 @@ if not.
313313
A _condition_ composition evaluates to true if and only if it produces a JSON
314314
dictionary with a field `value` with value `true`. Other fields are ignored.
315315
Because JSON values other than dictionaries are implicitly lifted to
316-
dictionaries with a `value` field, _condition_ may be a Javascript function
316+
dictionaries with a `value` field, _condition_ may be a JavaScript function
317317
returning a Boolean value. An expression such as `params.n > 0` is not a valid
318318
condition (or in general a valid composition). One should write instead `params
319319
=> params.n > 0`. The input parameter object for the composition is the input

docs/COMMANDS.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Flags:
4545
-v, --version output the composer version
4646
--debug LIST comma-separated list of debug flags (when using --js flag)
4747
```
48-
The `compose` command takes a Javascript module that exports a composition
48+
The `compose` command takes a JavaScript module that exports a composition
4949
object (for example [demo.js](../samples/demo.js)) and compiles this object to a
5050
portable JSON format on the standard output or in file.
5151
```

docs/COMPOSITIONS.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -85,10 +85,10 @@ output parameter objects of `myAction`.
8585

8686
## Components
8787

88-
Components of a compositions can be actions, Javascript functions, or
88+
Components of a compositions can be actions, JavaScript functions, or
8989
compositions.
9090

91-
Javascript functions can be viewed as simple, anonymous actions that do not need
91+
JavaScript functions can be viewed as simple, anonymous actions that do not need
9292
to be deployed and managed separately from the composition they belong to.
9393
Functions are typically used to alter a parameter object between two actions
9494
that expect different schemas, as in:

0 commit comments

Comments
 (0)