Skip to content

Commit

Permalink
Docs: Use fat arrows to signify return values (fixes #1)
Browse files Browse the repository at this point in the history
  • Loading branch information
phated committed Jun 27, 2016
1 parent 80ca7e2 commit 8a34f14
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,15 +163,15 @@ parallelSettlingFn(function(err, res){
__All bach APIs return an invoker function that takes a single callback as its only parameter.
The function signature is `function(error, results)`.__

### `series([executor, ])` : Function
### `series([executor, ])` => Function

All `executor` functions passed to this function will be called in series when the returned function is
called. If an error occurs, execution will stop and the error will be passed to the callback function
as the first parameter.

__The error parameter will always be a single error.__

### `parallel([executor, ])` : Function
### `parallel([executor, ])` => Function

All `executor` functions passed to this function will be called in parallel when the returned function is
called. If an error occurs, the error will be passed to the callback function
Expand All @@ -180,14 +180,14 @@ will __not__ be available.

__The error parameter will always be a single error.__

### `settleSeries([executor, ])` : Function
### `settleSeries([executor, ])` => Function

All `executor` functions passed to this function will be called in series when the returned function is
called. All functions will always be called and the callback will receive all settled errors and results.

__The error parameter will always be an array of errors.__

### `settleParallel([executor, ])` : Function
### `settleParallel([executor, ])` => Function

All `executor` functions passed to this function will be called in parallel when the returned function is
called. All functions will always be called and the callback will receive all settled errors and results.
Expand Down

0 comments on commit 8a34f14

Please sign in to comment.