Skip to content

Commit 8f8221b

Browse files
authored
docs: improve doctests for ndarray instances in blas/ext/ndarray/slinspace
PR-URL: #11549 Reviewed-by: Athan Reines <kgryte@gmail.com> Ref: #9329
1 parent 2367b73 commit 8f8221b

5 files changed

Lines changed: 5 additions & 24 deletions

File tree

lib/node_modules/@stdlib/blas/ext/base/ndarray/slinspace/README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ Fills a one-dimensional single-precision floating-point ndarray with linearly sp
4343
```javascript
4444
var Float32Array = require( '@stdlib/array/float32' );
4545
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
46-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
4746
var ndarray = require( '@stdlib/ndarray/base/ctor' );
4847

4948
var xbuf = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] );
@@ -62,10 +61,7 @@ var endpoint = scalar2ndarray( true, {
6261
});
6362

6463
var out = slinspace( [ x, start, end, endpoint ] );
65-
// returns <ndarray>
66-
67-
var arr = ndarray2array( out );
68-
// returns [ 0.0, 1.0, 2.0, 3.0 ]
64+
// returns <ndarray>[ 0.0, 1.0, 2.0, 3.0 ]
6965
```
7066

7167
The function has the following parameters:

lib/node_modules/@stdlib/blas/ext/base/ndarray/slinspace/docs/repl.txt

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,7 @@
5959

6060
// Fill the input ndarray:
6161
> {{alias}}( [ x, start, stop, endpoint ] )
62-
<ndarray>
63-
64-
> {{alias:@stdlib/ndarray/to-array}}( x )
65-
[ 0.0, 1.0, 2.0, 3.0 ]
62+
<ndarray>[ 0.0, 1.0, 2.0, 3.0 ]
6663

6764
See Also
6865
--------

lib/node_modules/@stdlib/blas/ext/base/ndarray/slinspace/docs/types/index.d.ts

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ import { float32ndarray, boolndarray } from '@stdlib/types/ndarray';
4040
* @example
4141
* var Float32Array = require( '@stdlib/array/float32' );
4242
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
43-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
4443
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
4544
*
4645
* var xbuf = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
@@ -59,10 +58,7 @@ import { float32ndarray, boolndarray } from '@stdlib/types/ndarray';
5958
* });
6059
*
6160
* var out = slinspace( [ x, start, stop, endpoint ] );
62-
* // returns <ndarray>
63-
*
64-
* var arr = ndarray2array( out );
65-
* // returns [ 0.0, 20.0, 40.0, 60.0, 80.0, 100.0 ]
61+
* // returns <ndarray>[ 0.0, 20.0, 40.0, 60.0, 80.0, 100.0 ]
6662
*/
6763
declare function slinspace( arrays: [ float32ndarray, float32ndarray, float32ndarray, boolndarray ] ): float32ndarray;
6864

lib/node_modules/@stdlib/blas/ext/base/ndarray/slinspace/lib/index.js

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626
* @example
2727
* var Float32Array = require( '@stdlib/array/float32' );
2828
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
29-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
3029
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
3130
* var slinspace = require( '@stdlib/blas/ext/base/ndarray/slinspace' );
3231
*
@@ -46,10 +45,7 @@
4645
* });
4746
*
4847
* var out = slinspace( [ x, start, stop, endpoint ] );
49-
* // returns <ndarray>
50-
*
51-
* var arr = ndarray2array( out );
52-
* // returns [ 0.0, 20.0, 40.0, 60.0, 80.0, 100.0 ]
48+
* // returns <ndarray>[ 0.0, 20.0, 40.0, 60.0, 80.0, 100.0 ]
5349
*/
5450

5551
// MODULES //

lib/node_modules/@stdlib/blas/ext/base/ndarray/slinspace/lib/main.js

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ var strided = require( '@stdlib/blas/ext/base/slinspace' ).ndarray;
4848
* @example
4949
* var Float32Array = require( '@stdlib/array/float32' );
5050
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
51-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
5251
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
5352
*
5453
* var xbuf = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
@@ -67,10 +66,7 @@ var strided = require( '@stdlib/blas/ext/base/slinspace' ).ndarray;
6766
* });
6867
*
6968
* var out = slinspace( [ x, start, stop, endpoint ] );
70-
* // returns <ndarray>
71-
*
72-
* var arr = ndarray2array( out );
73-
* // returns [ 0.0, 20.0, 40.0, 60.0, 80.0, 100.0 ]
69+
* // returns <ndarray>[ 0.0, 20.0, 40.0, 60.0, 80.0, 100.0 ]
7470
*/
7571
function slinspace( arrays ) {
7672
var endpoint;

0 commit comments

Comments
 (0)