-
Notifications
You must be signed in to change notification settings - Fork 33
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(data-point/readme): Replace the term TransformOptions with the word Object #211
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small question, otherwise LGTM. 👍
@@ -316,7 +316,7 @@ This method will return a **Promise** if `done` is omitted. | |||
| *options* | [Reducer](#reducers) | Request options. See this [example](#options-with-constants) for using constants in the reducer | | |||
| *done* | `function` _(optional)_ | Error-first callback [Node.js style callback](https://nodejs.org/api/errors.html#errors_node_js_style_callbacks) that has the arguments `(error, result)`, where `result` contains the final resolved [Accumulator](#accumulator). The actual transformation result will be inside the `result.value` property. | | |||
|
|||
**<a name="transform-options">TransformOptions</a>** | |||
**<a name="transform-options">Options</a>** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not visible, but do we also want to change the name
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I could change it, just not sure what a better name would be (since options
is probably too generic)
Replace the term TransformOptions with the word Object
What: Removes the term
TransformOptions
from the readme (closes #200)Why: It makes the readme more clear.
Checklist: