Skip to content

Commit d35e63b

Browse files
committed
[readme] address review comments from #357
1 parent 8d408bf commit d35e63b

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ The `start` method start (and restarts) mathjax-node. This allows reconfiguratio
9898

9999
### `typeset(options[, callback])`
100100

101-
The `typeset` method is the main method of mathjax-node. It expects a configuration object `input` and optionally a callback.
101+
The `typeset` method is the main method of mathjax-node. It expects a configuration object `options` and optionally a callback.
102102

103103
If no `callback` is passed, it will return a Promise.
104104

@@ -134,7 +134,7 @@ The following are the default input options.
134134
}
135135
```
136136

137-
### `Promise.resolve(result,options)` / `Promise.reject(errors) / `callback(result, options)`
137+
### `Promise.resolve(result,options)` / `Promise.reject(errors)` / `callback(result, options)`
138138

139139
mathjax-node returns two objects to `Promise.resolve` or `callback`: a `result` object and the original input `options`.
140140

@@ -167,6 +167,6 @@ The `result` object will contain (at most) the following structure:
167167
}
168168
```
169169

170-
If the `errors` array is non-empty, the Promise will reject.
170+
If the `errors` array is non-empty, the Promise will reject, and be passed the `errors` array.
171171

172172
The `options` contains the configuration object passed to `typeset`; this can be useful for passing other data along or for identifying which `typeset()` call is associated with this (`callback`) call (in case you use the same `callback` function for more than one `typeset()`).

0 commit comments

Comments
 (0)