Skip to content

Commit 25c54a9

Browse files
committed
docs: update return annotations to use ndarray instance notation
1 parent b4175e2 commit 25c54a9

File tree

4 files changed

+9
-19
lines changed

4 files changed

+9
-19
lines changed

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

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,8 @@ var ndarray = require( '@stdlib/ndarray/ctor' );
4141
var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
4242
var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
4343

44-
dapx( x, 5.0 );
45-
46-
var y = x.data;
47-
// returns <Float64Array>[ 6.0, 7.0, 8.0, 9.0 ]
44+
var out = dapx( x, 5.0 );
45+
// returns <ndarray>[ 6.0, 7.0, 8.0, 9.0 ]
4846
```
4947

5048
The function has the following parameters:
@@ -64,10 +62,8 @@ var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
6462
// Create an ndarray view:
6563
var x = new ndarray( 'float64', xbuf, [ 3 ], [ 1 ], 2, 'row-major' );
6664

67-
dapx( x, 5.0 );
68-
69-
var y = x.data;
70-
// returns <Float64Array>[ 1.0, 2.0, 8.0, 9.0, 10.0 ]
65+
var out = dapx( x, 5.0 );
66+
// returns <ndarray>[ 8.0, 9.0, 10.0 ]
7167
```
7268

7369
</section>

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,7 @@
2020
> var xbuf = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
2121
> var x = {{alias:@stdlib/ndarray/ctor}}( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
2222
> {{alias}}( x, 5.0 )
23-
<ndarray>
24-
> x.data
25-
<Float64Array>[ 6.0, 7.0, 8.0, 9.0 ]
23+
<ndarray>[ 6.0, 7.0, 8.0, 9.0 ]
2624

2725
See Also
2826
--------

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,8 @@ import { float64ndarray } from '@stdlib/types/ndarray';
3636
* var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
3737
* var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
3838
*
39-
* dapx( x, 5.0 );
40-
*
41-
* var y = x.data;
42-
* // returns <Float64Array>[ 6.0, 7.0, 8.0, 9.0 ]
39+
* var out = dapx( x, 5.0 );
40+
* // returns <ndarray>[ 6.0, 7.0, 8.0, 9.0 ]
4341
*/
4442
declare function dapx( x: float64ndarray, alpha: number ): float64ndarray;
4543

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,8 @@
3131
* var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
3232
* var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
3333
*
34-
* dapx( x, 5.0 );
35-
*
36-
* var y = x.data;
37-
* // returns <Float64Array>[ 6.0, 7.0, 8.0, 9.0 ]
34+
* var out = dapx( x, 5.0 );
35+
* // returns <ndarray>[ 6.0, 7.0, 8.0, 9.0 ]
3836
*/
3937

4038
// MODULES //

0 commit comments

Comments
 (0)