Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -702,6 +702,7 @@ A total of 40 issues were closed in this release:
 
 <details>
 
+-   [`141399c`](https://github.com/stdlib-js/stdlib/commit/141399ca349aa5d998ba9d5df2e46f4ceb316210) - **docs:** improve doctests for ndarray instances in `ndarray/flatten-by` [(#9666)](https://github.com/stdlib-js/stdlib/pull/9666) _(by Shreelaxmi Hegde)_
 -   [`bb5b731`](https://github.com/stdlib-js/stdlib/commit/bb5b7312bfd8a87b84615de701b8c1e132521e93) - **docs:** improve doctests for ndarray instances in `ndarray/flatten-from` [(#9668)](https://github.com/stdlib-js/stdlib/pull/9668) _(by Shreelaxmi Hegde)_
 -   [`3686f6f`](https://github.com/stdlib-js/stdlib/commit/3686f6f542397f4000ce69cd3f1e9f5052d68321) - **docs:** improve doctests for ndarray instances in `ndarray/flatten` [(#9665)](https://github.com/stdlib-js/stdlib/pull/9665) _(by Shreelaxmi Hegde)_
 -   [`279f181`](https://github.com/stdlib-js/stdlib/commit/279f1817651a774f8d97f053529ac2bd94a94f91) - **docs:** update parameter name and description in `ndarray/base` TypeScript declaration  [(#9660)](https://github.com/stdlib-js/stdlib/pull/9660) _(by stdlib-bot)_

flatten-by/README.md

@@ -42,7 +42,6 @@ Flattens an [ndarray][@stdlib/ndarray/ctor] according to a callback function.
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 
 function scale( value ) {
     return value * 2.0;
@@ -52,10 +51,7 @@ var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ] ] ] );
 // returns <ndarray>
 
 var y = flattenBy( x, scale );
-// returns <ndarray>
-
-var arr = ndarray2array( y );
-// returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
+// returns <ndarray>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
 ```
 
 The function accepts the following arguments:
@@ -84,7 +80,6 @@ By default, the function flattens all dimensions of the input [ndarray][@stdlib/
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 
 function scale( value ) {
     return value * 2.0;
@@ -98,17 +93,13 @@ var opts = {
 };
 
 var y = flattenBy( x, opts, scale );
-// returns <ndarray>
-
-var arr = ndarray2array( y );
-// returns [ [ 2.0, 4.0 ], [ 6.0, 8.0 ], [ 10.0, 12.0 ] ]
+// returns <ndarray>[ [ 2.0, 4.0 ], [ 6.0, 8.0 ], [ 10.0, 12.0 ] ]
 ```
 
 By default, the input [ndarray][@stdlib/ndarray/ctor] is flattened in lexicographic order. To flatten elements in a different order, specify the `order` option.
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 
 function scale( value ) {
     return value * 2.0;
@@ -122,18 +113,14 @@ var opts = {
 };
 
 var y = flattenBy( x, opts, scale );
-// returns <ndarray>
-
-var arr = ndarray2array( y );
-// returns [ 2.0, 6.0, 10.0, 4.0, 8.0, 12.0 ]
+// returns <ndarray>[ 2.0, 6.0, 10.0, 4.0, 8.0, 12.0 ]
 ```
 
 By default, the output ndarray [data type][@stdlib/ndarray/dtypes] is inferred from the input [ndarray][@stdlib/ndarray/ctor]. To return an ndarray with a different [data type][@stdlib/ndarray/dtypes], specify the `dtype` option.
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
 var dtype = require( '@stdlib/ndarray/dtype' );
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 
 function scale( value ) {
     return value * 2.0;
@@ -146,13 +133,10 @@ var opts = {
     'dtype': 'float32'
 };
 var y = flattenBy( x, opts, scale );
-// returns <ndarray>
+// returns <ndarray>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
 
 var dt = String( dtype( y ) );
 // returns 'float32'
-
-var arr = ndarray2array( y );
-// returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
 ```
 
 To set the callback function execution context, provide a `thisArg`.
@@ -161,7 +145,6 @@ To set the callback function execution context, provide a `thisArg`.
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 
 function scale( value ) {
     this.count += 1;
@@ -176,10 +159,7 @@ var ctx = {
 };
 
 var y = flattenBy( x, scale, ctx );
-// returns <ndarray>
-
-var arr = ndarray2array( y );
-// returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
+// returns <ndarray>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
 
 var count = ctx.count;
 // returns 6

flatten-by/docs/repl.txt

@@ -45,9 +45,8 @@
     --------
     > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );
     > function f ( v ) { return v * 2.0 };
-    > var y = {{alias}}( x, f );
-    > var arr = {{alias:@stdlib/ndarray/to-array}}( y )
-    [ 2.0, 4.0, 6.0, 8.0 ]
+    > var y = {{alias}}( x, f )
+    <ndarray>[ 2.0, 4.0, 6.0, 8.0 ]
 
     See Also
     --------

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

@@ -118,7 +118,6 @@ type Options<U> = BaseOptions & {
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
 * var ndarray = require( '@stdlib/ndarray/ctor' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * function scale( value ) {
 *     return value * 2.0;
@@ -133,10 +132,7 @@ type Options<U> = BaseOptions & {
 * // returns <ndarray>
 *
 * var y = flattenBy( x, scale );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
+* // returns <ndarray>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
 */
 declare function flattenBy<T extends typedndarray<number> = typedndarray<number>, ThisArg = unknown>( x: T, fcn: Callback<number, T, number, ThisArg>, thisArg?: ThisParameterType<Callback<number, T, number, ThisArg>> ): T;
 
@@ -151,7 +147,6 @@ declare function flattenBy<T extends typedndarray<number> = typedndarray<number>
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
 * var ndarray = require( '@stdlib/ndarray/ctor' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * function identity( value ) {
 *     return value;
@@ -181,7 +176,6 @@ declare function flattenBy<T extends ComplexLike = ComplexLike, U extends typedn
 * @example
 * var BooleanArray = require( '@stdlib/array/bool' );
 * var ndarray = require( '@stdlib/ndarray/ctor' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * function invert( value ) {
 *     return !value;
@@ -196,10 +190,7 @@ declare function flattenBy<T extends ComplexLike = ComplexLike, U extends typedn
 * // returns <ndarray>
 *
 * var y = flattenBy( x, invert );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ false, true, false, true, false, true ]
+* // returns <ndarray>[ false, true, false, true, false, true ]
 */
 declare function flattenBy<T extends typedndarray<boolean> = typedndarray<boolean>, ThisArg = unknown>( x: T, fcn: Callback<boolean, T, boolean, ThisArg>, thisArg?: ThisParameterType<Callback<boolean, T, boolean, ThisArg>> ): T;
 
@@ -213,7 +204,6 @@ declare function flattenBy<T extends typedndarray<boolean> = typedndarray<boolea
 *
 * @example
 * var ndarray = require( '@stdlib/ndarray/ctor' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * function scale( value ) {
 *     return value * 2.0;
@@ -228,10 +218,7 @@ declare function flattenBy<T extends typedndarray<boolean> = typedndarray<boolea
 * // returns <ndarray>
 *
 * var y = flattenBy( x, scale );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
+* // returns <ndarray>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
 */
 declare function flattenBy<T = unknown, U extends genericndarray<T> = genericndarray<T>, V = unknown, W extends genericndarray<V> = genericndarray<V>, ThisArg = unknown>( x: U, fcn: Callback<T, U, V, ThisArg>, thisArg?: ThisParameterType<Callback<T, U, V, ThisArg>> ): W;
 
@@ -250,7 +237,6 @@ declare function flattenBy<T = unknown, U extends genericndarray<T> = genericnda
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
 * var ndarray = require( '@stdlib/ndarray/ctor' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * function scale( value ) {
 *     return value * 2.0;
@@ -269,10 +255,7 @@ declare function flattenBy<T = unknown, U extends genericndarray<T> = genericnda
 * };
 *
 * var y = flattenBy( x, opts, scale );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
+* // returns <ndarray>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
 */
 declare function flattenBy<T extends typedndarray<number> = typedndarray<number>, ThisArg = unknown>( x: T, options: BaseOptions, fcn: Callback<number, T, number, ThisArg>, thisArg?: ThisParameterType<Callback<number, T, number, ThisArg>> ): T;
 
@@ -291,7 +274,6 @@ declare function flattenBy<T extends typedndarray<number> = typedndarray<number>
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
 * var ndarray = require( '@stdlib/ndarray/ctor' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * function identity( value ) {
 *     return value;
@@ -329,7 +311,6 @@ declare function flattenBy<T extends ComplexLike = ComplexLike, U extends typedn
 * @example
 * var BooleanArray = require( '@stdlib/array/bool' );
 * var ndarray = require( '@stdlib/ndarray/ctor' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * function invert( value ) {
 *     return !value;
@@ -348,10 +329,7 @@ declare function flattenBy<T extends ComplexLike = ComplexLike, U extends typedn
 * };
 *
 * var y = flattenBy( x, opts, invert );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ false, true, false, true, false, true ]
+* // returns <ndarray>[ false, true, false, true, false, true ]
 */
 declare function flattenBy<T extends typedndarray<boolean> = typedndarray<boolean>, ThisArg = unknown>( x: T, options: BaseOptions, fcn: Callback<boolean, T, boolean, ThisArg>, thisArg?: ThisParameterType<Callback<boolean, T, boolean, ThisArg>> ): T;
 
@@ -369,7 +347,6 @@ declare function flattenBy<T extends typedndarray<boolean> = typedndarray<boolea
 *
 * @example
 * var ndarray = require( '@stdlib/ndarray/ctor' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * function scale( value ) {
 *     return value * 2.0;
@@ -388,10 +365,7 @@ declare function flattenBy<T extends typedndarray<boolean> = typedndarray<boolea
 * };
 *
 * var y = flattenBy( x, opts, scale );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
+* // returns <ndarray>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
 */
 declare function flattenBy<T = unknown, U extends genericndarray<T> = genericndarray<T>, V = unknown, W extends genericndarray<V> = genericndarray<V>, ThisArg = unknown>( x: U, options: BaseOptions, fcn: Callback<T, U, V, ThisArg>, thisArg?: ThisParameterType<Callback<T, U, V, ThisArg>> ): W;
 
@@ -410,7 +384,6 @@ declare function flattenBy<T = unknown, U extends genericndarray<T> = genericnda
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
 * var ndarray = require( '@stdlib/ndarray/ctor' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * function scale( value ) {
 *     return value * 2.0;
@@ -429,10 +402,7 @@ declare function flattenBy<T = unknown, U extends genericndarray<T> = genericnda
 * };
 *
 * var y = flattenBy( x, opts, scale );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
+* // returns <ndarray>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
 */
 declare function flattenBy<T = unknown, U extends typedndarray<T> | genericndarray<T> = typedndarray<T>, V = unknown, W extends keyof DataTypeMap<T> = 'generic', ThisArg = unknown>( x: U, options: Options<W>, fcn: Callback<T, U, V, ThisArg>, thisArg?: ThisParameterType<Callback<T, U, V, ThisArg>> ): DataTypeMap<V>[W];
 

flatten-by/lib/index.js

@@ -25,7 +25,6 @@
 *
 * @example
 * var array = require( '@stdlib/ndarray/array' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 * var flattenBy = require( '@stdlib/ndarray/flatten-by' );
 *
 * function scale( value ) {
@@ -36,10 +35,7 @@
 * // returns <ndarray>
 *
 * var y = flattenBy( x, scale );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
+* // returns <ndarray>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
 */
 
 // MODULES //

flatten-by/lib/main.js

@@ -66,7 +66,6 @@ var COL_MAJOR = 'column-major';
 *
 * @example
 * var array = require( '@stdlib/ndarray/array' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * function scale( value ) {
 *     return value * 2.0;
@@ -76,10 +75,7 @@ var COL_MAJOR = 'column-major';
 * // returns <ndarray>
 *
 * var y = flattenBy( x, scale );
-* // returns <ndarray>
-*
-* var arr = ndarray2array( y );
-* // returns [ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
+* // returns <ndarray>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
 */
 function flattenBy( x, options, fcn, thisArg ) {
 	var hasOpts;