Skip to content

Commit cb1c457

Browse files
committed
Update JSDoc comments
1 parent e829c7c commit cb1c457

File tree

1 file changed

+11
-10
lines changed
  • lib/node_modules/@stdlib/iter/flow/lib

1 file changed

+11
-10
lines changed

lib/node_modules/@stdlib/iter/flow/lib/main.js

+11-10
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,17 @@ var iteratorSymbol = require( '@stdlib/symbol/iterator' );
3636
/**
3737
* Returns a constructor for creating a fluent interface for chaining together iterator methods.
3838
*
39+
* ## Notes
40+
*
41+
* - We assume that each provided iterator function has the following function signature:
42+
*
43+
* ```text
44+
* function iterFcn( iterator[, ...args] ) {...}
45+
* ```
46+
*
47+
* where `iterator` is an input iterator and `args` are additional iterator function arguments (if any).
48+
*
49+
*
3950
* @param {Object} methods - an object mapping method names to iterator functions
4051
* @throws {TypeError} must provide an object
4152
* @throws {TypeError} object property values must be functions
@@ -162,16 +173,6 @@ function iterFlow( methods ) {
162173
/**
163174
* Wraps an iterator function as a fluent interface method.
164175
*
165-
* ## Notes
166-
*
167-
* - We assume that the provided iterator function has the following function signature:
168-
*
169-
* ```text
170-
* function iterFcn( iterator[, ...args] ) {...}
171-
* ```
172-
*
173-
* where `iterator` is an input iterator and `args` are additional iterator function arguments (if any).
174-
*
175176
* @private
176177
* @param {Function} iterFcn - iterator function
177178
* @returns {Function} method wrapper

0 commit comments

Comments
 (0)