Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -3796,6 +3796,7 @@ A total of 586 issues were closed in this release:
 
 <details>
 
+-   [`a19ed4c`](https://github.com/stdlib-js/stdlib/commit/a19ed4c1ebd7a8e2124665cf5b9442e7e970eb19) - **docs:** improve doctests for ndarray instances in `stats/base/ndarray/cumax` [(#11522)](https://github.com/stdlib-js/stdlib/pull/11522) _(by Uday Kakade)_
 -   [`00385f6`](https://github.com/stdlib-js/stdlib/commit/00385f618ba07beba4fa4be45feee0f55591aa5f) - **docs:** improve doctests for ndarray instances in `stats/base/ndarray/dcumin` [(#11521)](https://github.com/stdlib-js/stdlib/pull/11521) _(by Uday Kakade)_
 -   [`2505815`](https://github.com/stdlib-js/stdlib/commit/25058156cf7b1138c5c33209a5143100c376b46d) - **docs:** update namespace table of contents [(#11520)](https://github.com/stdlib-js/stdlib/pull/11520) _(by stdlib-bot)_
 -   [`e616ec3`](https://github.com/stdlib-js/stdlib/commit/e616ec3c2b724c7b94937c8b892f54d5ef437719) - **docs:** capitalize `Pearson` and close backtick in `stats/strided/dpcorrwd` [(#11515)](https://github.com/stdlib-js/stdlib/pull/11515) _(by Philipp Burckhardt)_

base/ndarray/cumax/README.md

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

base/ndarray/cumax/docs/repl.txt

@@ -27,9 +27,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, 1.0, 2.0 ]
+    > {{alias}}( [ x, y ] )
+    <ndarray>[ 1.0, 1.0, 2.0 ]
 
     See Also
     --------

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

@@ -29,7 +29,6 @@ import { ndarray, typedndarray } from '@stdlib/types/ndarray';
 * @returns output ndarray
 *
 * @example
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 * var ndarray = require( '@stdlib/ndarray/base/ctor' );
 *
 * var xbuf = [ 1.0, 3.0, 4.0, 2.0 ];
@@ -39,13 +38,10 @@ import { ndarray, typedndarray } from '@stdlib/types/ndarray';
 * var y = new ndarray( 'generic', ybuf, [ 4 ], [ 1 ], 0, 'row-major' );
 *
 * var v = cumax( [ x, y ] );
-* // returns <ndarray>
+* // returns <ndarray>[ 1.0, 3.0, 4.0, 4.0 ]
 *
 * var bool = ( v === y );
 * // returns true
-*
-* var arr = ndarray2array( v );
-* // returns [ 1.0, 3.0, 4.0, 4.0 ]
 */
 declare function cumax<T extends typedndarray<unknown> = typedndarray<unknown>>( arrays: [ ndarray, T ] ): T;
 

base/ndarray/cumax/lib/index.js

@@ -24,7 +24,6 @@
 * @module @stdlib/stats/base/ndarray/cumax
 *
 * @example
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 * var ndarray = require( '@stdlib/ndarray/base/ctor' );
 * var cumax = require( '@stdlib/stats/base/ndarray/cumax' );
 *
@@ -35,13 +34,10 @@
 * var y = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
 *
 * var v = cumax( [ x, y ] );
-* // returns <ndarray>
+* // returns <ndarray>[ 1.0, 3.0, 4.0, 4.0 ]
 *
 * var bool = ( v === y );
 * // returns true
-*
-* var arr = ndarray2array( v );
-* // returns [ 1.0, 3.0, 4.0, 4.0 ]
 */
 
 // MODULES //

base/ndarray/cumax/lib/main.js

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