📚 docs: Fix some function signatures.

iterable-iterator · May 5, 2021 · da13ce6 · da13ce6
1 parent 8e75961
commit da13ce6
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 3 deletions.
diff --git a/src/enumerate.js b/src/enumerate.js
@@ -15,7 +15,7 @@ import _zip2 from './_zip2.js';
  * list( enumerate( 'abc' , 1 ) ) ;
  *
  * @param {Iterable} iterable - The input iterable.
- * @param {Number} [start=0] - The starting index.
+ * @param {number} [start=0] - The starting index.
  * @returns {IterableIterator}
  */
 export default function enumerate(iterable, start = 0) {

diff --git a/src/zip.js b/src/zip.js
@@ -10,8 +10,7 @@ import _zip from './_zip.js';
  * list( zip( 'abcd' , range(3) ) ) ;
  *
  * @param {...Iterable} iterables - The iterables to zip.
- * @returns {Iterator}
- *
+ * @returns {IterableIterator}
  */
 export default function zip(...iterables) {
 	return _zip(iterables);