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.

Sign up for GitHub

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

Jump to bottom

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2562,16 +2562,16 @@ Stream.prototype.split = function () {
exposeMethod('split');

/**
* Creates a new Stream with the values from the source in the range of `start` to `end`.
* Creates a new Stream with the values from the source in the range of `start` (inclusive) to `end` (exclusive).
* `start` and `end` must be of type `Number`, if `start` is not a `Number` it will default to `0`
* and, likewise, `end` will default to `Infinity`: this could result in the whole stream being be
* returned.
*
* @id slice
* @section Transforms
* @name Stream.slice(start, end)
* @param {Number} start - integer representing index to start reading from source
* @param {Number} stop - integer representing index to stop reading from source
* @param {Number} start - integer representing index to start reading from source (inclusive)
* @param {Number} stop - integer representing index to stop reading from source (exclusive)
* @api public
*
* _([1, 2, 3, 4]).slice(1, 3) // => 2, 3
Expand Down