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

[DOC] Add inline docs to stream util methods and rename chainStream to chain. #10105

Merged
merged 1 commit into from
Jan 1, 2015

Conversation

lukemelia
Copy link
Member

@mixonic spin-off of your pointers about the non-stream-safe util methods from #10093

@mmun
Copy link
Member

mmun commented Jan 1, 2015

Looks good.

  • These all need to be explicitly marked @private or given global exports behind a feature flag.
  • I don't like the name chainStream. I prefer chain or map.

@lukemelia
Copy link
Member Author

Thanks @mmun I'll mark them private for now and we can decide whether to expose them as public API over time. Also will rename chainStream to chain and do a little doc formatting cleanup.

@lukemelia lukemelia force-pushed the document-stream-utils branch from 036c39a to f15f9f7 Compare January 1, 2015 21:53
@lukemelia lukemelia changed the title [DOC] Add inline docs to stream util methods. [DOC] Add inline docs to stream util methods and rename chainStream to chain. Jan 1, 2015
@lukemelia
Copy link
Member Author

OK, all set from my perspective (pending a green build!).

@lukemelia lukemelia force-pushed the document-stream-utils branch from f15f9f7 to 7ef2dc1 Compare January 1, 2015 21:55
@lukemelia lukemelia force-pushed the document-stream-utils branch from 7ef2dc1 to f0db31e Compare January 1, 2015 22:01

@private
@function chain
@param {Object|Stream} array An array containing zero or more stream objects
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These aren't right.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

D'oh!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoops, good catch. Will fix.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix in #10107

rwjblue added a commit that referenced this pull request Jan 1, 2015
[DOC] Add inline docs to stream util methods and rename chainStream to chain.
@rwjblue rwjblue merged commit 1e087d2 into emberjs:master Jan 1, 2015
@rwjblue
Copy link
Member

rwjblue commented Jan 1, 2015

Thanks Luke!

@lukemelia lukemelia deleted the document-stream-utils branch January 1, 2015 22:50
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.

3 participants