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

api doc: clarify description of Stream.slice #381

Merged
merged 1 commit into from
Nov 10, 2015
Merged

api doc: clarify description of Stream.slice #381

merged 1 commit into from
Nov 10, 2015

Conversation

janriemer
Copy link
Contributor

Clarify the description of 'start' and 'stop' param.

Clarify the description of 'start' and 'stop' param.
@apaleslimghost
Copy link
Collaborator

I'm not sure this needs documenting. The arguments work the same as [].slice.

@vqvu
Copy link
Collaborator

vqvu commented Nov 10, 2015

Well, they don't work exactly like Array.slice since they don't allow negative values for the stop parameter. Plus, it doesn't hurt to mention this. The MDN docs for Array.slice itself mentions the "inclusive-ness"

Zero-based index at which to end extraction. slice extracts up to but not including end.

I'll merge this since the error seems to be a spurious failure in NPM instead of something we did.

vqvu added a commit that referenced this pull request Nov 10, 2015
api doc: clarify description of Stream.slice
@vqvu vqvu merged commit 3945c3e into caolan:master Nov 10, 2015
@janriemer janriemer deleted the patch-1 branch November 11, 2015 07:26
@vqvu vqvu added this to the v2.6.0 milestone Nov 18, 2015
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.

None yet

3 participants