chore: fix return annotation comments and spacing

Planeshifter · Planeshifter · commit ecde0dab6fa8 · 2025-09-18T21:29:22.000-05:00
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---
diff --git a/lib/node_modules/@stdlib/ndarray/base/assert/is-equal-data-type/README.md b/lib/node_modules/@stdlib/ndarray/base/assert/is-equal-data-type/README.md
@@ -91,7 +91,7 @@ bool = isEqualDataType( 'generic', new DataType( 'generic' ) );
 bool = isEqualDataType( 'int16', 'int32' );
 // returns false
 
-bool = isEqualDataType( 'int32', new DataType( 'int16') );
+bool = isEqualDataType( 'int32', new DataType( 'int16' ) );
 // returns false
 
 bool = isEqualDataType( 'foo', 'foo' );
diff --git a/lib/node_modules/@stdlib/ndarray/base/assert/is-equal-data-type/examples/index.js b/lib/node_modules/@stdlib/ndarray/base/assert/is-equal-data-type/examples/index.js
@@ -41,7 +41,7 @@ bool = isEqualDataType( 'int16', 'int32' );
 console.log( bool );
 // => false
 
-bool = isEqualDataType( 'int32', new DataType( 'int16') );
+bool = isEqualDataType( 'int32', new DataType( 'int16' ) );
 console.log( bool );
 // => false
 
diff --git a/lib/node_modules/@stdlib/ndarray/flatten-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/flatten-by/docs/types/index.d.ts
@@ -130,7 +130,7 @@ type Options<U> = BaseOptions & {
 * var offset = 0;
 *
 * var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' );
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var y = flattenBy( x, scale );
 * // returns <ndarray>
@@ -163,7 +163,7 @@ declare function flattenBy<T extends typedndarray<number> = typedndarray<number>
 * var offset = 0;
 *
 * var x = ndarray( 'complex64', buffer, shape, strides, offset, 'row-major' );
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var y = flattenBy( x, identity );
 * // returns <ndarray>
@@ -193,7 +193,7 @@ declare function flattenBy<T extends ComplexLike = ComplexLike, U extends typedn
 * var offset = 0;
 *
 * var x = ndarray( 'uint8c', buffer, shape, strides, offset, 'row-major' );
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var y = flattenBy( x, scale );
 * // returns <ndarray>
@@ -225,7 +225,7 @@ declare function flattenBy<T extends typedndarray<boolean> = typedndarray<boolea
 * var offset = 0;
 *
 * var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var y = flattenBy( x, scale );
 * // returns <ndarray>
@@ -262,7 +262,7 @@ declare function flattenBy<T = unknown, U extends genericndarray<T> = genericnda
 * var offset = 0;
 *
 * var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' );
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var opts = {
 *      'depth': 2
@@ -303,7 +303,7 @@ declare function flattenBy<T extends typedndarray<number> = typedndarray<number>
 * var offset = 0;
 *
 * var x = ndarray( 'complex64', buffer, shape, strides, offset, 'row-major' );
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var opts = {
 *      'depth': 1
@@ -341,7 +341,7 @@ declare function flattenBy<T extends ComplexLike = ComplexLike, U extends typedn
 * var offset = 0;
 *
 * var x = ndarray( 'uint8c', buffer, shape, strides, offset, 'row-major' );
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var opts = {
 *     'depth': 2
@@ -381,7 +381,7 @@ declare function flattenBy<T extends typedndarray<boolean> = typedndarray<boolea
 * var offset = 0;
 *
 * var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var opts = {
 *     'depth': 2
@@ -422,7 +422,7 @@ declare function flattenBy<T = unknown, U extends genericndarray<T> = genericnda
 * var offset = 0;
 *
 * var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' );
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var opts = {
 *      'depth': 2
diff --git a/lib/node_modules/@stdlib/ndarray/flatten-by/lib/index.js b/lib/node_modules/@stdlib/ndarray/flatten-by/lib/index.js
@@ -33,7 +33,7 @@
 * }
 *
 * var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var y = flattenBy( x, scale );
 * // returns <ndarray>
diff --git a/lib/node_modules/@stdlib/ndarray/flatten-by/lib/main.js b/lib/node_modules/@stdlib/ndarray/flatten-by/lib/main.js
@@ -73,7 +73,7 @@ var COL_MAJOR = 'column-major';
 * }
 *
 * var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var y = flattenBy( x, scale );
 * // returns <ndarray>
diff --git a/lib/node_modules/@stdlib/ndarray/flatten/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/flatten/docs/types/index.d.ts
@@ -82,7 +82,7 @@ type Options<U> = BaseOptions & {
 * var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var y = flatten( x );
 * // returns <ndarray>
@@ -111,7 +111,7 @@ declare function flatten<T extends ndarray>( x: T, options?: BaseOptions ): T;
 * var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var y = flatten( x );
 * // returns <ndarray>
diff --git a/lib/node_modules/@stdlib/ndarray/flatten/lib/index.js b/lib/node_modules/@stdlib/ndarray/flatten/lib/index.js
@@ -30,7 +30,7 @@
 *
 * // Create an input ndarray:
 * var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
-* // return <ndarray>
+* // returns <ndarray>
 *
 * // Flatten the input ndarray:
 * var y = flatten( x );
diff --git a/lib/node_modules/@stdlib/ndarray/flatten/lib/main.js b/lib/node_modules/@stdlib/ndarray/flatten/lib/main.js
@@ -65,7 +65,7 @@ var COL_MAJOR = 'column-major';
 * var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var y = flatten( x );
 * // returns <ndarray>
@@ -81,7 +81,7 @@ var COL_MAJOR = 'column-major';
 *     'shape': [ 2, 3 ],
 *     'order': 'column-major'
 * });
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var y = flatten( x );
 * // returns <ndarray>
@@ -97,7 +97,7 @@ var COL_MAJOR = 'column-major';
 *     'shape': [ 2, 3 ],
 *     'order': 'row-major'
 * });
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var y = flatten( x, {
 *     'order': 'column-major'
@@ -115,7 +115,7 @@ var COL_MAJOR = 'column-major';
 *     'shape': [ 2, 3 ],
 *     'order': 'column-major'
 * });
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var y = flatten( x, {
 *     'order': 'row-major'
@@ -133,7 +133,7 @@ var COL_MAJOR = 'column-major';
 *     'shape': [ 2, 3 ],
 *     'order': 'row-major'
 * });
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var y = flatten( x, {
 *     'order': 'same'
@@ -151,7 +151,7 @@ var COL_MAJOR = 'column-major';
 *     'shape': [ 2, 3 ],
 *     'order': 'column-major'
 * });
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var y = flatten( x, {
 *     'order': 'same'
@@ -168,7 +168,7 @@ var COL_MAJOR = 'column-major';
 * var xbuf = [ 1.0, null, 2.0, null, 3.0, null, 4.0, null, 5.0, null, 6.0, null ];
 *
 * var x = new ndarray( 'generic', xbuf, [ 2, 3 ], [ -6, -2 ], 10, 'row-major' );
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var y = flatten( x );
 * // returns <ndarray>
@@ -184,7 +184,7 @@ var COL_MAJOR = 'column-major';
 *
 * // Create an ndarray whose stated order is column-major, but which has been transposed:
 * var x = new ndarray( 'generic', xbuf, [ 2, 3 ], [ -6, -2 ], 10, 'column-major' );
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var y = flatten( x );
 * // returns <ndarray>
@@ -200,7 +200,7 @@ var COL_MAJOR = 'column-major';
 *
 * // Create an ndarray whose stated order is column-major, but which has been transposed:
 * var x = new ndarray( 'generic', xbuf, [ 2, 3 ], [ -6, -2 ], 10, 'column-major' );
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var y = flatten( x, {
 *     'order': 'same'
@@ -218,7 +218,7 @@ var COL_MAJOR = 'column-major';
 *
 * // Create an ndarray whose stated order is column-major, but which has been transposed:
 * var x = new ndarray( 'generic', xbuf, [ 2, 3 ], [ -6, -2 ], 10, 'column-major' );
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var y = flatten( x, {
 *     'order': 'any'
@@ -236,7 +236,7 @@ var COL_MAJOR = 'column-major';
 *
 * // Create an ndarray whose stated order is row-major, but which has been transposed:
 * var x = new ndarray( 'generic', xbuf, [ 2, 3 ], [ -2, -4 ], 10, 'row-major' );
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var y = flatten( x );
 * // returns <ndarray>
@@ -252,7 +252,7 @@ var COL_MAJOR = 'column-major';
 *
 * // Create an ndarray whose stated order is row-major, but which has been transposed:
 * var x = new ndarray( 'generic', xbuf, [ 2, 3 ], [ -2, -4 ], 10, 'row-major' );
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var y = flatten( x, {
 *     'order': 'same'
@@ -270,7 +270,7 @@ var COL_MAJOR = 'column-major';
 *
 * // Create an ndarray whose stated order is row-major, but which has been transposed:
 * var x = new ndarray( 'generic', xbuf, [ 2, 3 ], [ -2, -4 ], 10, 'row-major' );
-* // return <ndarray>
+* // returns <ndarray>
 *
 * var y = flatten( x, {
 *     'order': 'any'

Original file line number	Diff line number	Diff line change
`@@ -130,7 +130,7 @@ type Options<U> = BaseOptions & {`
`130`	`130`	`* var offset = 0;`
`131`	`131`	`*`
`132`	`132`	`* var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' );`
`133`		`-* // return <ndarray>`
	`133`	`+* // returns <ndarray>`
`134`	`134`	`*`
`135`	`135`	`* var y = flattenBy( x, scale );`
`136`	`136`	`* // returns <ndarray>`
`@@ -163,7 +163,7 @@ declare function flattenBy<T extends typedndarray<number> = typedndarray<number>`
`163`	`163`	`* var offset = 0;`
`164`	`164`	`*`
`165`	`165`	`* var x = ndarray( 'complex64', buffer, shape, strides, offset, 'row-major' );`
`166`		`-* // return <ndarray>`
	`166`	`+* // returns <ndarray>`
`167`	`167`	`*`
`168`	`168`	`* var y = flattenBy( x, identity );`
`169`	`169`	`* // returns <ndarray>`
`@@ -193,7 +193,7 @@ declare function flattenBy<T extends ComplexLike = ComplexLike, U extends typedn`
`193`	`193`	`* var offset = 0;`
`194`	`194`	`*`
`195`	`195`	`* var x = ndarray( 'uint8c', buffer, shape, strides, offset, 'row-major' );`
`196`		`-* // return <ndarray>`
	`196`	`+* // returns <ndarray>`
`197`	`197`	`*`
`198`	`198`	`* var y = flattenBy( x, scale );`
`199`	`199`	`* // returns <ndarray>`
`@@ -225,7 +225,7 @@ declare function flattenBy<T extends typedndarray<boolean> = typedndarray<boolea`
`225`	`225`	`* var offset = 0;`
`226`	`226`	`*`
`227`	`227`	`* var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );`
`228`		`-* // return <ndarray>`
	`228`	`+* // returns <ndarray>`
`229`	`229`	`*`
`230`	`230`	`* var y = flattenBy( x, scale );`
`231`	`231`	`* // returns <ndarray>`
`@@ -262,7 +262,7 @@ declare function flattenBy<T = unknown, U extends genericndarray<T> = genericnda`
`262`	`262`	`* var offset = 0;`
`263`	`263`	`*`
`264`	`264`	`* var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' );`
`265`		`-* // return <ndarray>`
	`265`	`+* // returns <ndarray>`
`266`	`266`	`*`
`267`	`267`	`* var opts = {`
`268`	`268`	`* 'depth': 2`
`@@ -303,7 +303,7 @@ declare function flattenBy<T extends typedndarray<number> = typedndarray<number>`
`303`	`303`	`* var offset = 0;`
`304`	`304`	`*`
`305`	`305`	`* var x = ndarray( 'complex64', buffer, shape, strides, offset, 'row-major' );`
`306`		`-* // return <ndarray>`
	`306`	`+* // returns <ndarray>`
`307`	`307`	`*`
`308`	`308`	`* var opts = {`
`309`	`309`	`* 'depth': 1`
`@@ -341,7 +341,7 @@ declare function flattenBy<T extends ComplexLike = ComplexLike, U extends typedn`
`341`	`341`	`* var offset = 0;`
`342`	`342`	`*`
`343`	`343`	`* var x = ndarray( 'uint8c', buffer, shape, strides, offset, 'row-major' );`
`344`		`-* // return <ndarray>`
	`344`	`+* // returns <ndarray>`
`345`	`345`	`*`
`346`	`346`	`* var opts = {`
`347`	`347`	`* 'depth': 2`
`@@ -381,7 +381,7 @@ declare function flattenBy<T extends typedndarray<boolean> = typedndarray<boolea`
`381`	`381`	`* var offset = 0;`
`382`	`382`	`*`
`383`	`383`	`* var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );`
`384`		`-* // return <ndarray>`
	`384`	`+* // returns <ndarray>`
`385`	`385`	`*`
`386`	`386`	`* var opts = {`
`387`	`387`	`* 'depth': 2`
`@@ -422,7 +422,7 @@ declare function flattenBy<T = unknown, U extends genericndarray<T> = genericnda`
`422`	`422`	`* var offset = 0;`
`423`	`423`	`*`
`424`	`424`	`* var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' );`
`425`		`-* // return <ndarray>`
	`425`	`+* // returns <ndarray>`
`426`	`426`	`*`
`427`	`427`	`* var opts = {`
`428`	`428`	`* 'depth': 2`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@`
`33`	`33`	`* }`
`34`	`34`	`*`
`35`	`35`	`* var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );`
`36`		`-* // return <ndarray>`
	`36`	`+* // returns <ndarray>`
`37`	`37`	`*`
`38`	`38`	`* var y = flattenBy( x, scale );`
`39`	`39`	`* // returns <ndarray>`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ var COL_MAJOR = 'column-major';`
`73`	`73`	`* }`
`74`	`74`	`*`
`75`	`75`	`* var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );`
`76`		`-* // return <ndarray>`
	`76`	`+* // returns <ndarray>`
`77`	`77`	`*`
`78`	`78`	`* var y = flattenBy( x, scale );`
`79`	`79`	`* // returns <ndarray>`
Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ type Options<U> = BaseOptions & {`
`82`	`82`	`* var ndarray2array = require( '@stdlib/ndarray/to-array' );`
`83`	`83`	`*`
`84`	`84`	`* var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );`
`85`		`-* // return <ndarray>`
	`85`	`+* // returns <ndarray>`
`86`	`86`	`*`
`87`	`87`	`* var y = flatten( x );`
`88`	`88`	`* // returns <ndarray>`
`@@ -111,7 +111,7 @@ declare function flatten<T extends ndarray>( x: T, options?: BaseOptions ): T;`
`111`	`111`	`* var ndarray2array = require( '@stdlib/ndarray/to-array' );`
`112`	`112`	`*`
`113`	`113`	`* var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );`
`114`		`-* // return <ndarray>`
	`114`	`+* // returns <ndarray>`
`115`	`115`	`*`
`116`	`116`	`* var y = flatten( x );`
`117`	`117`	`* // returns <ndarray>`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@`
`30`	`30`	`*`
`31`	`31`	`* // Create an input ndarray:`
`32`	`32`	`* var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );`
`33`		`-* // return <ndarray>`
	`33`	`+* // returns <ndarray>`
`34`	`34`	`*`
`35`	`35`	`* // Flatten the input ndarray:`
`36`	`36`	`* var y = flatten( x );`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ var COL_MAJOR = 'column-major';`
`65`	`65`	`* var ndarray2array = require( '@stdlib/ndarray/to-array' );`
`66`	`66`	`*`
`67`	`67`	`* var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );`
`68`		`-* // return <ndarray>`
	`68`	`+* // returns <ndarray>`
`69`	`69`	`*`
`70`	`70`	`* var y = flatten( x );`
`71`	`71`	`* // returns <ndarray>`
`@@ -81,7 +81,7 @@ var COL_MAJOR = 'column-major';`
`81`	`81`	`* 'shape': [ 2, 3 ],`
`82`	`82`	`* 'order': 'column-major'`
`83`	`83`	`* });`
`84`		`-* // return <ndarray>`
	`84`	`+* // returns <ndarray>`
`85`	`85`	`*`
`86`	`86`	`* var y = flatten( x );`
`87`	`87`	`* // returns <ndarray>`
`@@ -97,7 +97,7 @@ var COL_MAJOR = 'column-major';`
`97`	`97`	`* 'shape': [ 2, 3 ],`
`98`	`98`	`* 'order': 'row-major'`
`99`	`99`	`* });`
`100`		`-* // return <ndarray>`
	`100`	`+* // returns <ndarray>`
`101`	`101`	`*`
`102`	`102`	`* var y = flatten( x, {`
`103`	`103`	`* 'order': 'column-major'`
`@@ -115,7 +115,7 @@ var COL_MAJOR = 'column-major';`
`115`	`115`	`* 'shape': [ 2, 3 ],`
`116`	`116`	`* 'order': 'column-major'`
`117`	`117`	`* });`
`118`		`-* // return <ndarray>`
	`118`	`+* // returns <ndarray>`
`119`	`119`	`*`
`120`	`120`	`* var y = flatten( x, {`
`121`	`121`	`* 'order': 'row-major'`
`@@ -133,7 +133,7 @@ var COL_MAJOR = 'column-major';`
`133`	`133`	`* 'shape': [ 2, 3 ],`
`134`	`134`	`* 'order': 'row-major'`
`135`	`135`	`* });`
`136`		`-* // return <ndarray>`
	`136`	`+* // returns <ndarray>`
`137`	`137`	`*`
`138`	`138`	`* var y = flatten( x, {`
`139`	`139`	`* 'order': 'same'`
`@@ -151,7 +151,7 @@ var COL_MAJOR = 'column-major';`
`151`	`151`	`* 'shape': [ 2, 3 ],`
`152`	`152`	`* 'order': 'column-major'`
`153`	`153`	`* });`
`154`		`-* // return <ndarray>`
	`154`	`+* // returns <ndarray>`
`155`	`155`	`*`
`156`	`156`	`* var y = flatten( x, {`
`157`	`157`	`* 'order': 'same'`
`@@ -168,7 +168,7 @@ var COL_MAJOR = 'column-major';`
`168`	`168`	`* var xbuf = [ 1.0, null, 2.0, null, 3.0, null, 4.0, null, 5.0, null, 6.0, null ];`
`169`	`169`	`*`
`170`	`170`	`* var x = new ndarray( 'generic', xbuf, [ 2, 3 ], [ -6, -2 ], 10, 'row-major' );`
`171`		`-* // return <ndarray>`
	`171`	`+* // returns <ndarray>`
`172`	`172`	`*`
`173`	`173`	`* var y = flatten( x );`
`174`	`174`	`* // returns <ndarray>`
`@@ -184,7 +184,7 @@ var COL_MAJOR = 'column-major';`
`184`	`184`	`*`
`185`	`185`	`* // Create an ndarray whose stated order is column-major, but which has been transposed:`
`186`	`186`	`* var x = new ndarray( 'generic', xbuf, [ 2, 3 ], [ -6, -2 ], 10, 'column-major' );`
`187`		`-* // return <ndarray>`
	`187`	`+* // returns <ndarray>`
`188`	`188`	`*`
`189`	`189`	`* var y = flatten( x );`
`190`	`190`	`* // returns <ndarray>`
`@@ -200,7 +200,7 @@ var COL_MAJOR = 'column-major';`
`200`	`200`	`*`
`201`	`201`	`* // Create an ndarray whose stated order is column-major, but which has been transposed:`
`202`	`202`	`* var x = new ndarray( 'generic', xbuf, [ 2, 3 ], [ -6, -2 ], 10, 'column-major' );`
`203`		`-* // return <ndarray>`
	`203`	`+* // returns <ndarray>`
`204`	`204`	`*`
`205`	`205`	`* var y = flatten( x, {`
`206`	`206`	`* 'order': 'same'`
`@@ -218,7 +218,7 @@ var COL_MAJOR = 'column-major';`
`218`	`218`	`*`
`219`	`219`	`* // Create an ndarray whose stated order is column-major, but which has been transposed:`
`220`	`220`	`* var x = new ndarray( 'generic', xbuf, [ 2, 3 ], [ -6, -2 ], 10, 'column-major' );`
`221`		`-* // return <ndarray>`
	`221`	`+* // returns <ndarray>`
`222`	`222`	`*`
`223`	`223`	`* var y = flatten( x, {`
`224`	`224`	`* 'order': 'any'`
`@@ -236,7 +236,7 @@ var COL_MAJOR = 'column-major';`
`236`	`236`	`*`
`237`	`237`	`* // Create an ndarray whose stated order is row-major, but which has been transposed:`
`238`	`238`	`* var x = new ndarray( 'generic', xbuf, [ 2, 3 ], [ -2, -4 ], 10, 'row-major' );`
`239`		`-* // return <ndarray>`
	`239`	`+* // returns <ndarray>`
`240`	`240`	`*`
`241`	`241`	`* var y = flatten( x );`
`242`	`242`	`* // returns <ndarray>`
`@@ -252,7 +252,7 @@ var COL_MAJOR = 'column-major';`
`252`	`252`	`*`
`253`	`253`	`* // Create an ndarray whose stated order is row-major, but which has been transposed:`
`254`	`254`	`* var x = new ndarray( 'generic', xbuf, [ 2, 3 ], [ -2, -4 ], 10, 'row-major' );`
`255`		`-* // return <ndarray>`
	`255`	`+* // returns <ndarray>`
`256`	`256`	`*`
`257`	`257`	`* var y = flatten( x, {`
`258`	`258`	`* 'order': 'same'`
`@@ -270,7 +270,7 @@ var COL_MAJOR = 'column-major';`
`270`	`270`	`*`
`271`	`271`	`* // Create an ndarray whose stated order is row-major, but which has been transposed:`
`272`	`272`	`* var x = new ndarray( 'generic', xbuf, [ 2, 3 ], [ -2, -4 ], 10, 'row-major' );`
`273`		`-* // return <ndarray>`
	`273`	`+* // returns <ndarray>`
`274`	`274`	`*`
`275`	`275`	`* var y = flatten( x, {`
`276`	`276`	`* 'order': 'any'`