From 065486599a8d4c6bef69ac0b41ed3476d5d93518 Mon Sep 17 00:00:00 2001 From: Uday Kakade Date: Fri, 17 Apr 2026 23:20:11 +0530 Subject: [PATCH] docs: improve doctest for ndarray instances in ndarray/reverse --- lib/node_modules/@stdlib/ndarray/reverse/README.md | 11 ++--------- .../@stdlib/ndarray/reverse/docs/repl.txt | 8 ++------ .../@stdlib/ndarray/reverse/docs/types/index.d.ts | 11 ++--------- lib/node_modules/@stdlib/ndarray/reverse/lib/index.js | 11 ++--------- lib/node_modules/@stdlib/ndarray/reverse/lib/main.js | 11 ++--------- 5 files changed, 10 insertions(+), 42 deletions(-) diff --git a/lib/node_modules/@stdlib/ndarray/reverse/README.md b/lib/node_modules/@stdlib/ndarray/reverse/README.md index e71693720ed2..f77263aeaa74 100644 --- a/lib/node_modules/@stdlib/ndarray/reverse/README.md +++ b/lib/node_modules/@stdlib/ndarray/reverse/README.md @@ -46,21 +46,14 @@ Returns a read-only view of an input [`ndarray`][@stdlib/ndarray/ctor] in which ```javascript var array = require( '@stdlib/ndarray/array' ); -var ndarray2array = require( '@stdlib/ndarray/to-array' ); var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], { 'shape': [ 3, 2 ] }); -// returns - -var arr = ndarray2array( x ); -// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] +// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] var y = reverse( x ); -// returns - -arr = ndarray2array( y ); -// returns [ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ] +// returns [ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ] ``` diff --git a/lib/node_modules/@stdlib/ndarray/reverse/docs/repl.txt b/lib/node_modules/@stdlib/ndarray/reverse/docs/repl.txt index 4af1dfe9212d..6dffda7a028d 100644 --- a/lib/node_modules/@stdlib/ndarray/reverse/docs/repl.txt +++ b/lib/node_modules/@stdlib/ndarray/reverse/docs/repl.txt @@ -17,13 +17,9 @@ Examples -------- > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ) - - > {{alias:@stdlib/ndarray/to-array}}( x ) - [ [ 1, 2 ], [ 3, 4 ] ] + [ [ 1, 2 ], [ 3, 4 ] ] > var y = {{alias}}( x ) - - > {{alias:@stdlib/ndarray/to-array}}( y ) - [ [ 4, 3 ], [ 2, 1 ] ] + [ [ 4, 3 ], [ 2, 1 ] ] See Also -------- diff --git a/lib/node_modules/@stdlib/ndarray/reverse/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/reverse/docs/types/index.d.ts index 86f5cc3b987a..4d79739b8fd5 100644 --- a/lib/node_modules/@stdlib/ndarray/reverse/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/ndarray/reverse/docs/types/index.d.ts @@ -30,7 +30,6 @@ import { ndarray } from '@stdlib/types/ndarray'; * * @example * var ndarray = require( '@stdlib/ndarray/ctor' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]; * var shape = [ 3, 2 ]; @@ -38,16 +37,10 @@ import { ndarray } from '@stdlib/types/ndarray'; * var offset = 0; * * var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' ); -* // returns -* -* var arr = ndarray2array( x ); -* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] +* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] * * var y = reverse( x ); -* // returns -* -* arr = ndarray2array( y ); -* // returns [ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ] +* // returns [ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ] */ declare function reverse( x: T ): T; diff --git a/lib/node_modules/@stdlib/ndarray/reverse/lib/index.js b/lib/node_modules/@stdlib/ndarray/reverse/lib/index.js index fb0494a6e37c..689659f7a734 100644 --- a/lib/node_modules/@stdlib/ndarray/reverse/lib/index.js +++ b/lib/node_modules/@stdlib/ndarray/reverse/lib/index.js @@ -25,7 +25,6 @@ * * @example * var ndarray = require( '@stdlib/ndarray/ctor' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var reverse = require( '@stdlib/ndarray/reverse' ); * * var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]; @@ -34,16 +33,10 @@ * var offset = 0; * * var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' ); -* // returns -* -* var arr = ndarray2array( x ); -* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] +* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] * * var y = reverse( x ); -* // returns -* -* arr = ndarray2array( y ); -* // returns [ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ] +* // returns [ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/ndarray/reverse/lib/main.js b/lib/node_modules/@stdlib/ndarray/reverse/lib/main.js index c854bf310afb..06b2a4a79d9a 100644 --- a/lib/node_modules/@stdlib/ndarray/reverse/lib/main.js +++ b/lib/node_modules/@stdlib/ndarray/reverse/lib/main.js @@ -36,7 +36,6 @@ var format = require( '@stdlib/string/format' ); * * @example * var ndarray = require( '@stdlib/ndarray/ctor' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * * var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]; * var shape = [ 3, 2 ]; @@ -44,16 +43,10 @@ var format = require( '@stdlib/string/format' ); * var offset = 0; * * var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' ); -* // returns -* -* var arr = ndarray2array( x ); -* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] +* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] * * var y = reverse( x ); -* // returns -* -* arr = ndarray2array( y ); -* // returns [ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ] +* // returns [ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ] */ function reverse( x ) { if ( !isndarrayLike( x ) ) {