Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-10-02)
+## Unreleased (2025-10-03)
 
 <section class="features">
 
@@ -602,6 +602,7 @@ A total of 27 issues were closed in this release:
 
 <details>
 
+-   [`157f4f4`](https://github.com/stdlib-js/stdlib/commit/157f4f4cd7cc3ce680dbfb538b3d8cbcfe5852dd) - **docs:** update comments _(by Athan Reines)_
 -   [`17b3ee2`](https://github.com/stdlib-js/stdlib/commit/17b3ee291d0ff12089dcf3ff881771b41325ff28) - **chore:** fix C lint errors [(#8181)](https://github.com/stdlib-js/stdlib/pull/8181) _(by Piyush Goel, Athan Reines)_
 -   [`cb7cf8c`](https://github.com/stdlib-js/stdlib/commit/cb7cf8ce407731354c5b2861ffa659c8adbc3149) - **feat:** add `ndarray/reverse-dimension` [(#8186)](https://github.com/stdlib-js/stdlib/pull/8186) _(by Muhammad Haris, Athan Reines)_
 -   [`bc45275`](https://github.com/stdlib-js/stdlib/commit/bc4527566e313868d308532a06d9257156361e32) - **refactor:** simplify declarations by using generic _(by Athan Reines)_

CONTRIBUTORS

@@ -128,6 +128,7 @@ NEEKUorAAYUSH <aayush10072004@gmail.com>
 Nakul Krishnakumar <nakulkrishnakumar86@gmail.com>
 Naresh Jagadeesan <naresh.naresh000@gmail.com>
 Naveen Kumar <stupiddint@gmail.com>
+Navyansh Kesarwani <91735202+navyansh007@users.noreply.github.com>
 Neeraj Pathak <neerajrpathak710@gmail.com>
 NirvedMishra <139633597+NirvedMishra@users.noreply.github.com>
 Nishant Shinde <97207366+nishant-s7@users.noreply.github.com>
@@ -141,6 +142,7 @@ Ori Miles <97595296+orimiles5@users.noreply.github.com>
 Payal Goswami <payalgoswami9711@gmail.com>
 Philipp Burckhardt <pburckhardt@outlook.com>
 Pierre Forstmann <15964998+pierreforstmann@users.noreply.github.com>
+Piyush Goel <piyush.goel2704@gmail.com>
 Pradyumn Prasad <pradyumnprasad.567@gmail.com>
 Prajjwal Bajpai <142303989+prajjwalbajpai@users.noreply.github.com>
 Prajwal Kulkarni <prajwalkulkarni76@gmail.com>

flatten/docs/types/test.ts

@@ -84,7 +84,7 @@ import flatten = require( './index' );
 	flatten( zeros( 'generic', [ 2, 2, 2 ], 'row-major' ), ( x: number ): number => x ); // $ExpectError
 }
 
-// The compiler throws an error if the function is provided a second argument with invalid `depth` option...
+// The compiler throws an error if the function is provided a second argument with an invalid `depth` option...
 {
 	flatten( zeros( 'float64', [ 2, 2, 2 ], 'row-major' ), { 'depth': '5' } ); // $ExpectError
 	flatten( zeros( 'float64', [ 2, 2, 2 ], 'row-major' ), { 'depth': true } ); // $ExpectError
@@ -108,7 +108,7 @@ import flatten = require( './index' );
 	flatten( zeros( 'generic', [ 2, 2, 2 ], 'row-major' ), { 'depth': ( x: number ): number => x } ); // $ExpectError
 }
 
-// The compiler throws an error if the function is provided a second argument with invalid `order` option...
+// The compiler throws an error if the function is provided a second argument with an invalid `order` option...
 {
 	flatten( zeros( 'float64', [ 2, 2, 2 ], 'row-major' ), { 'order': '5' } ); // $ExpectError
 	flatten( zeros( 'float64', [ 2, 2, 2 ], 'row-major' ), { 'order': true } ); // $ExpectError
@@ -132,7 +132,7 @@ import flatten = require( './index' );
 	flatten( zeros( 'generic', [ 2, 2, 2 ], 'row-major' ), { 'order': ( x: number ): number => x } ); // $ExpectError
 }
 
-// The compiler throws an error if the function is provided a second argument with invalid `dtype` option...
+// The compiler throws an error if the function is provided a second argument with an invalid `dtype` option...
 {
 	flatten( zeros( 'float64', [ 2, 2, 2 ], 'row-major' ), { 'dtype': '5' } ); // $ExpectError
 	flatten( zeros( 'float64', [ 2, 2, 2 ], 'row-major' ), { 'dtype': true } ); // $ExpectError

flatten/lib/main.js

@@ -349,7 +349,7 @@ function flatten( x, options ) {
 		'dtype': opts.dtype
 	});
 
-	// Create a view on top of output ndarray having the same shape as the input ndarray:
+	// Create a view on top of the output ndarray having the same shape as the input ndarray:
 	st = ( xsh.length > 0 ) ? shape2strides( xsh, opts.order ) : [ 0 ];
 	view = ndarray( opts.dtype, getData( y ), xsh, st, 0, opts.order );