Add missing default and update examples

kgryte · kgryte · commit 2c9548a7dc64 · 2019-08-29T14:38:03.000-07:00
diff --git a/lib/node_modules/@stdlib/iter/strided-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/iter/strided-by/docs/types/index.d.ts
@@ -98,7 +98,7 @@ type Callback = Nullary | Unary | Binary | Ternary | Quaternary;
 * @param iterator - input iterator
 * @param fcn - callback function which returns the next stride
 * @param offset - offset
-* @param eager - boolean indicating whether to eagerly advance an input iterator when provided a non-zero `offset`
+* @param eager - boolean indicating whether to eagerly advance an input iterator when provided a non-zero `offset` (default: false)
 * @param thisArg - execution context
 * @returns iterator
 *
@@ -111,7 +111,7 @@ type Callback = Nullary | Unary | Binary | Ternary | Quaternary;
 *     return (i % 10) + 1;
 * }
 *
-* var iter = iterStridedBy( arr, stride, 1 );
+* var iter = iterStridedBy( arr, stride, 1, true );
 *
 * var r = iter.next().value;
 * // returns 1
@@ -198,16 +198,16 @@ declare function iterStridedBy( iterator: Iterator, fcn: Callback, offset?: numb
 *     return (i % 10) + 1;
 * }
 *
-* var iter = iterStridedBy( arr, stride, 1 );
+* var iter = iterStridedBy( arr, stride, null );
 *
 * var r = iter.next().value;
-* // returns 1
+* // returns 0
 *
 * r = iter.next().value;
-* // returns 2
+* // returns 1
 *
 * r = iter.next().value;
-* // returns 4
+* // returns 2
 *
 * // ...
 */

Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,7 @@ type Callback = Nullary \| Unary \| Binary \| Ternary \| Quaternary;`
`98`	`98`	`* @param iterator - input iterator`
`99`	`99`	`* @param fcn - callback function which returns the next stride`
`100`	`100`	`* @param offset - offset`
`101`		-* @param eager - boolean indicating whether to eagerly advance an input iterator when provided a non-zero `offset`
	`101`	+* @param eager - boolean indicating whether to eagerly advance an input iterator when provided a non-zero `offset` (default: false)
`102`	`102`	`* @param thisArg - execution context`
`103`	`103`	`* @returns iterator`
`104`	`104`	`*`
`@@ -111,7 +111,7 @@ type Callback = Nullary \| Unary \| Binary \| Ternary \| Quaternary;`
`111`	`111`	`* return (i % 10) + 1;`
`112`	`112`	`* }`
`113`	`113`	`*`
`114`		`-* var iter = iterStridedBy( arr, stride, 1 );`
	`114`	`+* var iter = iterStridedBy( arr, stride, 1, true );`
`115`	`115`	`*`
`116`	`116`	`* var r = iter.next().value;`
`117`	`117`	`* // returns 1`
`@@ -198,16 +198,16 @@ declare function iterStridedBy( iterator: Iterator, fcn: Callback, offset?: numb`
`198`	`198`	`* return (i % 10) + 1;`
`199`	`199`	`* }`
`200`	`200`	`*`
`201`		`-* var iter = iterStridedBy( arr, stride, 1 );`
	`201`	`+* var iter = iterStridedBy( arr, stride, null );`
`202`	`202`	`*`
`203`	`203`	`* var r = iter.next().value;`
`204`		`-* // returns 1`
	`204`	`+* // returns 0`
`205`	`205`	`*`
`206`	`206`	`* r = iter.next().value;`
`207`		`-* // returns 2`
	`207`	`+* // returns 1`
`208`	`208`	`*`
`209`	`209`	`* r = iter.next().value;`
`210`		`-* // returns 4`
	`210`	`+* // returns 2`
`211`	`211`	`*`
`212`	`212`	`* // ...`
`213`	`213`	`*/`