Skip to content

Commit 4c6c7a1

Browse files
authored
docs: improve doctests for ndarray instances in ndarray/base/reverse
PR-URL: #11509 Reviewed-by: Athan Reines <kgryte@gmail.com> Ref: #9329
1 parent c1376cb commit 4c6c7a1

File tree

5 files changed

+10
-45
lines changed

5 files changed

+10
-45
lines changed

lib/node_modules/@stdlib/ndarray/base/reverse/README.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,30 +46,23 @@ Returns a view of an input ndarray in which the order of elements along each dim
4646

4747
```javascript
4848
var ndarray = require( '@stdlib/ndarray/ctor' );
49-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
5049

5150
var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
5251
var shape = [ 3, 2 ];
5352
var strides = [ 2, 1 ];
5453
var offset = 0;
5554

5655
var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
57-
// returns <ndarray>
56+
// returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
5857

5958
var sh = x.shape;
6059
// returns [ 3, 2 ]
6160

62-
var arr = ndarray2array( x );
63-
// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
64-
6561
var y = reverse( x, false );
66-
// returns <ndarray>
62+
// returns <ndarray>[ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ]
6763

6864
sh = y.shape;
6965
// returns [ 3, 2 ]
70-
71-
arr = ndarray2array( y );
72-
// returns [ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ]
7366
```
7467

7568
The function accepts the following arguments:

lib/node_modules/@stdlib/ndarray/base/reverse/docs/repl.txt

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,9 @@
2020

2121
Examples
2222
--------
23-
> var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] )
24-
<ndarray>
25-
> x.shape
26-
[ 2, 2 ]
23+
> var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] );
2724
> var y = {{alias}}( x, false )
28-
<ndarray>
29-
> y.shape
30-
[ 2, 2 ]
31-
> {{alias:@stdlib/ndarray/to-array}}( y )
32-
[ [ 4, 3 ], [ 2, 1 ] ]
25+
<ndarray>[ [ 4, 3 ], [ 2, 1 ] ]
3326

3427
See Also
3528
--------

lib/node_modules/@stdlib/ndarray/base/reverse/docs/types/index.d.ts

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,30 +32,23 @@ import { ndarray } from '@stdlib/types/ndarray';
3232
* @example
3333
* var typedarray = require( '@stdlib/array/typed' );
3434
* var ndarray = require( '@stdlib/ndarray/ctor' );
35-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
3635
*
3736
* var buffer = typedarray( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], 'float64' );
3837
* var shape = [ 3, 2 ];
3938
* var strides = [ 2, 1 ];
4039
* var offset = 0;
4140
*
4241
* var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' );
43-
* // returns <ndarray>
42+
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
4443
*
4544
* var sh = x.shape;
4645
* // returns [ 3, 2 ]
4746
*
48-
* var arr = ndarray2array( x );
49-
* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
50-
*
5147
* var y = reverse( x, false );
52-
* // returns <ndarray>
48+
* // returns <ndarray>[ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ]
5349
*
5450
* sh = y.shape;
5551
* // returns [ 3, 2 ]
56-
*
57-
* arr = ndarray2array( y );
58-
* // returns [ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ]
5952
*/
6053
declare function reverse<T extends ndarray>( x: T, writable: boolean ): T;
6154

lib/node_modules/@stdlib/ndarray/base/reverse/lib/index.js

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
*
2626
* @example
2727
* var ndarray = require( '@stdlib/ndarray/ctor' );
28-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
2928
* var reverse = require( '@stdlib/ndarray/base/reverse' );
3029
*
3130
* var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
@@ -34,22 +33,16 @@
3433
* var offset = 0;
3534
*
3635
* var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
37-
* // returns <ndarray>
36+
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
3837
*
3938
* var sh = x.shape;
4039
* // returns [ 3, 2 ]
4140
*
42-
* var arr = ndarray2array( x );
43-
* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
44-
*
4541
* var y = reverse( x, false );
46-
* // returns <ndarray>
42+
* // returns <ndarray>[ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ]
4743
*
4844
* sh = y.shape;
4945
* // returns [ 3, 2 ]
50-
*
51-
* arr = ndarray2array( y );
52-
* // returns [ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ]
5346
*/
5447

5548
// MODULES //

lib/node_modules/@stdlib/ndarray/base/reverse/lib/main.js

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,30 +38,23 @@ var ndims = require( '@stdlib/ndarray/base/ndims' );
3838
*
3939
* @example
4040
* var ndarray = require( '@stdlib/ndarray/ctor' );
41-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
4241
*
4342
* var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
4443
* var shape = [ 3, 2 ];
4544
* var strides = [ 2, 1 ];
4645
* var offset = 0;
4746
*
4847
* var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
49-
* // returns <ndarray>
48+
* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
5049
*
5150
* var sh = x.shape;
5251
* // returns [ 3, 2 ]
5352
*
54-
* var arr = ndarray2array( x );
55-
* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
56-
*
5753
* var y = reverse( x, false );
58-
* // returns <ndarray>
54+
* // returns <ndarray>[ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ]
5955
*
6056
* sh = y.shape;
6157
* // returns [ 3, 2 ]
62-
*
63-
* arr = ndarray2array( y );
64-
* // returns [ [ 6.0, 5.0 ], [ 4.0, 3.0 ], [ 2.0, 1.0 ] ]
6558
*/
6659
function reverse( x, writable ) {
6760
var args = filled( new Slice( null, null, -1 ), ndims( x ) );

0 commit comments

Comments
 (0)