docs: fix and align TSDoc comments in iter declarations

PR-URL: #12726
Reviewed-by: Athan Reines <kgryte@gmail.com>

Author: Planeshifter

lib/node_modules/@stdlib/iter/cusome-by/docs/types/index.d.ts

@@ -62,7 +62,7 @@ type Predicate<T, U> = Nullary<U> | Unary<T, U> | Binary<T, U>;
 * Returns an iterator which cumulatively tests whether at least `n` iterated values pass a test implemented by a predicate function.
 *
 * @param iterator - source iterator
-* @param n - minimum number of truthy elements
+* @param n - minimum number of successful values
 * @param predicate - predicate function
 * @param thisArg - execution context
 * @returns iterator

lib/node_modules/@stdlib/iter/cusome/docs/types/index.d.ts

@@ -55,7 +55,8 @@ type Iterator = Iter | IterableIterator;
 * v = it.next().value;
 * // returns true
 *
-* // ..
+* var bool = it.next().done;
+* // returns true
 */
 declare function iterCuSome( iterator: Iterator, n: number ): Iterator;
 

lib/node_modules/@stdlib/iter/datespace/docs/types/index.d.ts

@@ -81,7 +81,7 @@ declare function iterDatespace( start: number | string | Date, stop: number | st
 * @param start - starting date as either a `Date` object, JavaScript timestamp, or a date string (inclusive)
 * @param stop - stopping date as either a `Date` object, JavaScript timestamp, or a date string (inclusive)
 * @param options - function options
-* @param options.round - specifies how sub-millisecond times should be rounded: 'floor', 'ceil', or 'round' (default: 'floor' )
+* @param options.round - specifies how sub-millisecond times should be rounded: 'floor', 'ceil', or 'round' (default: 'floor')
 * @throws a numeric `start` argument must be a nonnegative integer
 * @throws a numeric `stop` argument must be a nonnegative integer
 * @throws unable to parse date string

lib/node_modules/@stdlib/iter/dedupe-by/docs/types/index.d.ts

@@ -86,8 +86,9 @@ type Quinary = ( curr: any, sprev: any, dprev: any, index: number, acc: any ) =>
 * Indicates whether an iterated value is a "duplicate".
 *
 * @param curr - current source iterated value
-* @param prev - previous iterated value
-* @param index - iteration index (zero-based)
+* @param sprev - previous source iterated value
+* @param dprev - previous downstream iterated value
+* @param index - source iteration index (zero-based)
 * @param acc - previous resolved value
 * @returns resolved value
 */

lib/node_modules/@stdlib/iter/do-until-each/docs/types/index.d.ts

@@ -132,7 +132,7 @@ type Predicate = nullaryPredicate | unaryPredicate | binaryPredicate;
 * // returns 2
 *
 * r = it.next().value;
-* // undefined
+* // returns undefined
 *
 * // ...
 */

lib/node_modules/@stdlib/iter/do-while-each/docs/types/index.d.ts

@@ -93,7 +93,7 @@ type Predicate = nullaryPredicate | unaryPredicate | binaryPredicate;
 
 /**
 * Returns an iterator which invokes a function for each iterated value **before** returning the iterated value until either a predicate function returns `false` or the iterator has iterated over all values.
-* The condition is evaluated *after* executing the provided function; thus, fcn` *always* executes at least once.
+* The condition is evaluated *after* executing the provided function; thus, `fcn` *always* executes at least once.
 *
 * ## Notes
 *

lib/node_modules/@stdlib/iter/fill/docs/types/index.d.ts

@@ -35,7 +35,7 @@ type Iterator = Iter | IterableIterator;
 *
 * @param iterator - input iterator
 * @param value - static (fill) value
-* @param begin - start iteration index (inclusive)
+* @param begin - start iteration index (inclusive; default: 0)
 * @param end - end iteration index (non-inclusive)
 * @returns iterator
 *

lib/node_modules/@stdlib/iter/pipeline-thunk/docs/types/index.d.ts

@@ -26,11 +26,11 @@ import { Iterator as Iter, IterableIterator } from '@stdlib/types/iter';
 type Iterator = Iter | IterableIterator;
 
 /**
-* Iterator function
+* Iterator function.
 *
 * @param iterator - input iterator
 * @param args - function arguments
-* @returns hash value
+* @returns iterator function result
 */
 type IteratorFunction = ( iterator: Iterator, ...args: Array<any> ) => any;
 

lib/node_modules/@stdlib/iter/replicate-by/docs/types/index.d.ts

@@ -70,7 +70,7 @@ type Ternary = ( value: any, index: number, n: number ) => number;
 type Callback = Nullary | Unary | Binary | Ternary;
 
 /**
-* Returns an iterator which invokes a function for each iterated value.
+* Returns an iterator which replicates each iterated value according to a provided function.
 *
 * ## Notes
 *

lib/node_modules/@stdlib/iter/strided/docs/types/index.d.ts

@@ -35,7 +35,7 @@ type Iterator = Iter | IterableIterator;
 * @param iterator - input iterator
 * @param stride - 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)
 * @returns iterator
 *
 * @example