Skip to content

Commit 2367b73

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

5 files changed

Lines changed: 5 additions & 24 deletions

File tree

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ Fills a one-dimensional ndarray with linearly spaced values over a specified int
4242

4343
```javascript
4444
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
45-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
4645
var ndarray = require( '@stdlib/ndarray/base/ctor' );
4746

4847
var xbuf = [ 0.0, 0.0, 0.0, 0.0 ];
@@ -61,10 +60,7 @@ var endpoint = scalar2ndarray( true, {
6160
});
6261

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

7066
The function has the following parameters:

lib/node_modules/@stdlib/blas/ext/base/ndarray/glinspace/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/glinspace/docs/types/index.d.ts

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ import { typedndarray } from '@stdlib/types/ndarray';
3939
*
4040
* @example
4141
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
42-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
4342
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
4443
*
4544
* var xbuf = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
@@ -58,10 +57,7 @@ import { typedndarray } from '@stdlib/types/ndarray';
5857
* });
5958
*
6059
* var out = glinspace( [ x, start, stop, endpoint ] );
61-
* // returns <ndarray>
62-
*
63-
* var arr = ndarray2array( out );
64-
* // returns [ 0.0, 20.0, 40.0, 60.0, 80.0, 100.0 ]
60+
* // returns <ndarray>[ 0.0, 20.0, 40.0, 60.0, 80.0, 100.0 ]
6561
*/
6662
declare function glinspace<T extends typedndarray<number> = typedndarray<number>>( arrays: [ T, typedndarray<number>, typedndarray<number>, typedndarray<boolean> ] ): T;
6763

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
*
2626
* @example
2727
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
28-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
2928
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
3029
* var glinspace = require( '@stdlib/blas/ext/base/ndarray/glinspace' );
3130
*
@@ -45,10 +44,7 @@
4544
* });
4645
*
4746
* var out = glinspace( [ x, start, stop, endpoint ] );
48-
* // returns <ndarray>
49-
*
50-
* var arr = ndarray2array( out );
51-
* // returns [ 0.0, 20.0, 40.0, 60.0, 80.0, 100.0 ]
47+
* // returns <ndarray>[ 0.0, 20.0, 40.0, 60.0, 80.0, 100.0 ]
5248
*/
5349

5450
// MODULES //

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@ var strided = require( '@stdlib/blas/ext/base/glinspace' ).ndarray;
4747
*
4848
* @example
4949
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
50-
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
5150
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
5251
*
5352
* var xbuf = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
@@ -66,10 +65,7 @@ var strided = require( '@stdlib/blas/ext/base/glinspace' ).ndarray;
6665
* });
6766
*
6867
* var out = glinspace( [ x, start, stop, endpoint ] );
69-
* // returns <ndarray>
70-
*
71-
* var arr = ndarray2array( out );
72-
* // returns [ 0.0, 20.0, 40.0, 60.0, 80.0, 100.0 ]
68+
* // returns <ndarray>[ 0.0, 20.0, 40.0, 60.0, 80.0, 100.0 ]
7369
*/
7470
function glinspace( arrays ) {
7571
var endpoint;

0 commit comments

Comments
 (0)