Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -3798,6 +3798,7 @@ A total of 586 issues were closed in this release:
 
 <details>
 
+-   [`a6b67f6`](https://github.com/stdlib-js/stdlib/commit/a6b67f6978e82bbcb309c36dfda36a7d28b19fbf) - **docs:** improve doctests for ndarray instances in `stats/base/ndarray/scumin` [(#11532)](https://github.com/stdlib-js/stdlib/pull/11532) _(by Uday Kakade)_
 -   [`1588bf2`](https://github.com/stdlib-js/stdlib/commit/1588bf256bf277102e267b41a7d68c1798293b7e) - **feat:** add `svariance` to namespace _(by Athan Reines)_
 -   [`d985063`](https://github.com/stdlib-js/stdlib/commit/d985063b6fc9348485640f52158bbea28c7e4b86) - **feat:** add `stats/base/ndarray/svariance` [(#11510)](https://github.com/stdlib-js/stdlib/pull/11510) _(by Pratik)_
 -   [`71a93c8`](https://github.com/stdlib-js/stdlib/commit/71a93c88b8f794e067e62bfb86e0e549c3b27a0b) - **docs:** improve doctests for ndarray instances in `stats/base/ndarray/dcuminabs` [(#11526)](https://github.com/stdlib-js/stdlib/pull/11526) _(by Uday Kakade)_

base/ndarray/scumin/README.md

@@ -42,7 +42,6 @@ Computes the cumulative minimum value of a one-dimensional single-precision floa
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 var ndarray = require( '@stdlib/ndarray/base/ctor' );
 
 var xbuf = new Float32Array( [ 1.0, 3.0, 4.0, 2.0 ] );
@@ -52,13 +51,10 @@ var ybuf = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] );
 var y = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
 
 var v = scumin( [ x, y ] );
-// returns <ndarray>
+// returns <ndarray>[ 1.0, 1.0, 1.0, 1.0 ]
 
 var bool = ( v === y );
 // returns true
-
-var arr = ndarray2array( v );
-// returns [ 1.0, 1.0, 1.0, 1.0 ]
 ```
 
 The function has the following parameters:

base/ndarray/scumin/docs/repl.txt

@@ -28,9 +28,8 @@
     > var ord = 'row-major';
     > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, st, oo, ord );
     > var y = new {{alias:@stdlib/ndarray/ctor}}( dt, ybuf, sh, st, oo, ord );
-    > {{alias}}( [ x, y ] );
-    > {{alias:@stdlib/ndarray/to-array}}( y )
-    [ 1.0, -2.0, -2.0 ]
+    > {{alias}}( [ x, y ] )
+    <ndarray>[ 1.0, -2.0, -2.0 ]
 
     See Also
     --------

base/ndarray/scumin/docs/types/index.d.ts

@@ -30,7 +30,6 @@ import { float32ndarray } from '@stdlib/types/ndarray';
 *
 * @example
 * var Float32Array = require( '@stdlib/array/float32' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 * var ndarray = require( '@stdlib/ndarray/base/ctor' );
 *
 * var xbuf = new Float32Array( [ 1.0, 3.0, 4.0, 2.0 ] );
@@ -40,13 +39,10 @@ import { float32ndarray } from '@stdlib/types/ndarray';
 * var y = new ndarray( 'float32', ybuf, [ 4 ], [ 1 ], 0, 'row-major' );
 *
 * var v = scumin( [ x, y ] );
-* // returns <ndarray>
+* // returns <ndarray>[ 1.0, 1.0, 1.0, 1.0 ]
 *
 * var bool = ( v === y );
 * // returns true
-*
-* var arr = ndarray2array( v );
-* // returns [ 1.0, 1.0, 1.0, 1.0 ]
 */
 declare function scumin( arrays: [ float32ndarray, float32ndarray ] ): float32ndarray;
 

base/ndarray/scumin/lib/index.js

@@ -25,7 +25,6 @@
 *
 * @example
 * var Float32Array = require( '@stdlib/array/float32' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 * var ndarray = require( '@stdlib/ndarray/base/ctor' );
 * var scumin = require( '@stdlib/stats/base/ndarray/scumin' );
 *
@@ -36,13 +35,10 @@
 * var y = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
 *
 * var v = scumin( [ x, y ] );
-* // returns <ndarray>
+* // returns <ndarray>[ 1.0, 1.0, 1.0, 1.0 ]
 *
 * var bool = ( v === y );
 * // returns true
-*
-* var arr = ndarray2array( v );
-* // returns [ 1.0, 1.0, 1.0, 1.0 ]
 */
 
 // MODULES //

base/ndarray/scumin/lib/main.js

@@ -37,7 +37,6 @@ var strided = require( './../../../../strided/scumin' ).ndarray;
 *
 * @example
 * var Float32Array = require( '@stdlib/array/float32' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 * var ndarray = require( '@stdlib/ndarray/base/ctor' );
 *
 * var xbuf = new Float32Array( [ 1.0, 3.0, 4.0, 2.0 ] );
@@ -47,13 +46,10 @@ var strided = require( './../../../../strided/scumin' ).ndarray;
 * var y = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
 *
 * var v = scumin( [ x, y ] );
-* // returns <ndarray>
+* // returns <ndarray>[ 1.0, 1.0, 1.0, 1.0 ]
 *
 * var bool = ( v === y );
 * // returns true
-*
-* var arr = ndarray2array( v );
-* // returns [ 1.0, 1.0, 1.0, 1.0 ]
 */
 function scumin( arrays ) {
 	var x = arrays[ 0 ];