Skip to content
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

Merged
merged 2 commits into from
Feb 15, 2018

Conversation

raingerber
Copy link
Contributor

What: Removes the term TransformOptions from the readme (closes #200)

Why: It makes the readme more clear.

Checklist:

  • Has Breaking changes n/a
  • Documentation
  • Tests n/a
  • Ready to be merged

@raingerber raingerber self-assigned this Feb 13, 2018
@coveralls
Copy link

coveralls commented Feb 13, 2018

Coverage Status

Coverage remained the same at 100.0% when pulling cfaa3ce on raingerber:rename-TransformOptions into 64f5e54 on ViacomInc:master.

@raingerber raingerber closed this Feb 13, 2018
@raingerber raingerber reopened this Feb 13, 2018
@raingerber raingerber assigned raingerber and unassigned raingerber Feb 13, 2018
Copy link
Collaborator

@paulmolluzzo paulmolluzzo left a 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>**
Copy link
Collaborator

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?

Copy link
Contributor Author

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)

@acatl acatl merged commit b608245 into ViacomInc:master Feb 15, 2018
victorsingh pushed a commit to victorsingh/data-point that referenced this pull request Feb 15, 2018
Replace the term TransformOptions with the word Object
@raingerber raingerber deleted the rename-TransformOptions branch February 18, 2018 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove the term TransformOptions from the readme
4 participants