Skip to content

Commit 9805220

Browse files
committed
docs: update return annotations to use ndarray instance notation
1 parent 854d97c commit 9805220

4 files changed

Lines changed: 7 additions & 15 deletions

File tree

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,8 @@ var array = require( '@stdlib/ndarray/array' );
4646

4747
var x = array( new Float32Array( [ 1.0, 2.0, 3.0 ] ) );
4848

49-
sfill( x, 5.0 );
50-
51-
var xbuf = x.data;
52-
// returns <Float32Array>[ 5.0, 5.0, 5.0 ]
49+
var out = sfill( x, 5.0 );
50+
// returns <ndarray>[ 5.0, 5.0, 5.0 ]
5351
```
5452

5553
The function has the following parameters:

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,7 @@
1919
--------
2020
> var x = {{alias:@stdlib/ndarray/array}}( new {{alias:@stdlib/array/float32}}( [ 1.0, 2.0, 3.0 ] ) );
2121
> {{alias}}( x, 5.0 )
22-
<ndarray>
23-
> x.data
24-
<Float32Array>[ 5.0, 5.0, 5.0 ]
22+
<ndarray>[ 5.0, 5.0, 5.0 ]
2523

2624
See Also
2725
--------

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,8 @@ import { float32ndarray } from '@stdlib/types/ndarray';
3535
*
3636
* var x = array( new Float32Array( [ 1.0, 2.0, 3.0 ] ) );
3737
*
38-
* sfill( x, 5.0 );
39-
*
40-
* var xbuf = x.data;
41-
* // returns <Float32Array>[ 5.0, 5.0, 5.0 ]
38+
* var out = sfill( x, 5.0 );
39+
* // returns <ndarray>[ 5.0, 5.0, 5.0 ]
4240
*/
4341
declare function sfill( x: float32ndarray, alpha: number ): float32ndarray;
4442

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,8 @@
3030
*
3131
* var x = array( new Float32Array( [ 1.0, 2.0, 3.0 ] ) );
3232
*
33-
* sfill( x, 5.0 );
34-
*
35-
* var xbuf = x.data;
36-
* // returns <Float32Array>[ 5.0, 5.0, 5.0 ]
33+
* var out = sfill( x, 5.0 );
34+
* // returns <ndarray>[ 5.0, 5.0, 5.0 ]
3735
*/
3836

3937
// MODULES //

0 commit comments

Comments
 (0)