Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-09-24)
+## Unreleased (2025-09-29)
 
 <section class="features">
 
@@ -37,6 +37,7 @@
 
 <details>
 
+-   [`b7c2031`](https://github.com/stdlib-js/stdlib/commit/b7c20312491bdcf54ffc681e5fe489b9ba3d059c) - **docs:** clean-up TSDoc declaration comments _(by Philipp Burckhardt)_
 -   [`4f34af5`](https://github.com/stdlib-js/stdlib/commit/4f34af565334a8b431e81bc5325c502529f456c6) - **chore:** remove extra spaces and add missing TSDoc comments _(by Philipp Burckhardt)_
 -   [`70afd90`](https://github.com/stdlib-js/stdlib/commit/70afd90be6d343a43bcb374f01acc8dd3b8e6899) - **feat:** update `iter` TypeScript declarations _(by Philipp Burckhardt)_
 -   [`78620b6`](https://github.com/stdlib-js/stdlib/commit/78620b6184bd362245406d3c6af826455a0b78fc) - **chore:** disable lint directives _(by Philipp Burckhardt)_

CONTRIBUTORS

@@ -223,6 +223,7 @@ Yaswanth Kosuru <116426380+yaswanthkosuru@users.noreply.github.com>
 Yernar Yergaziyev <yernar.yergaziyev@erg.kz>
 Yugal Kaushik <yugalkaushik14@gmail.com>
 Yuvi Mittal <128018763+yuvi-mittal@users.noreply.github.com>
+Zuhair Ahmad <157193652+Zuhair-CS@users.noreply.github.com>
 deepak427 <62477872+deepak427@users.noreply.github.com>
 devshree-bhati <147095250+devshree-bhati@users.noreply.github.com>
 ditsu <170345142+ditsus@users.noreply.github.com>

do-until-each/docs/types/index.d.ts

@@ -116,9 +116,9 @@ type Predicate = nullaryPredicate | unaryPredicate | binaryPredicate;
 *     return v > 2;
 * }
 *
-* function assert( v, i ) {
-*     if ( i > 1 ) {
-*         throw new Error( 'unexpected error' );
+* function assert( v ) {
+*     if ( v !== v ) {
+*         throw new Error( 'should not be NaN' );
 *     }
 * }
 *

do-until-each/docs/types/test.ts

@@ -57,7 +57,6 @@ function predicate( v: unknown, i: number ): boolean {
 *
 * @param v - iterated value
 * @param i - iteration index
-* @returns callback result
 */
 function fcn( v: unknown, i: number ): void {
 	if ( v !== v || i !== i ) {

do-while-each/docs/types/index.d.ts

@@ -117,9 +117,9 @@ type Predicate = nullaryPredicate | unaryPredicate | binaryPredicate;
 *     return v < 3;
 * }
 *
-* function assert( v, i ) {
-*     if ( i > 1 ) {
-*         throw new Error( 'unexpected error' );
+* function assert( v ) {
+*     if ( v !== v ) {
+*         throw new Error( 'should not be NaN' );
 *     }
 * }
 *

do-while-each/docs/types/test.ts

@@ -57,7 +57,6 @@ function predicate( v: any, i: number ): boolean {
 *
 * @param v - iterated value
 * @param i - iteration index
-* @returns callback result
 */
 function fcn( v: any, i: number ): any {
 	if ( v !== v || i !== i ) {

logspace/docs/types/index.d.ts

@@ -52,7 +52,7 @@ interface Options {
 * @returns iterator
 *
 * @example
-* var iter = iterLogspace( 0, 1000, 4 );
+* var iter = iterLogspace( 0, 3, 4 );
 *
 * var v = iter.next().value;
 * // returns 1

strided-by/docs/types/index.d.ts

@@ -117,10 +117,10 @@ type Callback = Nullary | Unary | Binary | Ternary | Quaternary;
 * // returns 1
 *
 * r = iter.next().value;
-* // returns 2
+* // returns 3
 *
 * r = iter.next().value;
-* // returns 4
+* // returns 7
 *
 * // ...
 */
@@ -161,10 +161,10 @@ declare function iterStridedBy( iterator: Iterator, fcn: Callback, offset?: numb
 * // returns 1
 *
 * r = iter.next().value;
-* // returns 2
+* // returns 3
 *
 * r = iter.next().value;
-* // returns 4
+* // returns 7
 *
 * // ...
 */
@@ -207,7 +207,7 @@ declare function iterStridedBy( iterator: Iterator, fcn: Callback, offset?: numb
 * // returns 1
 *
 * r = iter.next().value;
-* // returns 2
+* // returns 3
 *
 * // ...
 */