Skip to content

Commit 41a146e

Browse files
Aniket-SSWitty-31-06
authored andcommitted
docs: improve doctests for ndarray instances in blas/ddot
PR-URL: stdlib-js#10720 Ref: stdlib-js#9329 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent fd69115 commit 41a146e

5 files changed

Lines changed: 6 additions & 26 deletions

File tree

lib/node_modules/@stdlib/blas/ddot/README.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,7 @@ var x = array( new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ) );
6363
var y = array( new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ) );
6464

6565
var z = ddot( x, y );
66-
// returns <ndarray>
67-
68-
var v = z.get();
69-
// returns -5.0
66+
// returns <ndarray>[ -5.0 ]
7067
```
7168

7269
The function has the following parameters:
@@ -88,13 +85,7 @@ var x = array( new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0, 3.0 ] ), opts );
8885
var y = array( new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0, 2.0 ] ), opts );
8986

9087
var z = ddot( x, y );
91-
// returns <ndarray>
92-
93-
var v1 = z.get( 0 );
94-
// returns 23.0
95-
96-
var v2 = z.get( 1 );
97-
// returns -22.0
88+
// returns <ndarray>[ 23.0, -22.0 ]
9889
```
9990

10091
</section>

lib/node_modules/@stdlib/blas/ddot/docs/repl.txt

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,7 @@
4545
> var ybuf = new {{alias:@stdlib/array/float64}}( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );
4646
> var y = {{alias:@stdlib/ndarray/array}}( ybuf );
4747
> var z = {{alias}}( x, y )
48-
<ndarray>
49-
> z.get()
50-
-5.0
48+
<ndarray>[ -5.0 ]
5149

5250
See Also
5351
--------

lib/node_modules/@stdlib/blas/ddot/docs/types/index.d.ts

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,7 @@ import { float64ndarray } from '@stdlib/types/ndarray';
5252
* var y = array( new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ) );
5353
*
5454
* var z = ddot( x, y );
55-
* // returns <ndarray>
56-
*
57-
* var v = z.get();
58-
* // returns -5.0
55+
* // returns <ndarray>[ -5.0 ]
5956
*/
6057
declare function ddot( x: float64ndarray, y: float64ndarray, dim?: number ): float64ndarray;
6158

lib/node_modules/@stdlib/blas/ddot/lib/index.js

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,7 @@
3232
* var y = array( new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ) );
3333
*
3434
* var z = ddot( x, y );
35-
* // returns <ndarray>
36-
*
37-
* var v = z.get();
38-
* // returns -5.0
35+
* // returns <ndarray>[ -5.0 ]
3936
*/
4037

4138
// MODULES //

lib/node_modules/@stdlib/blas/ddot/lib/main.js

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,7 @@ var format = require( '@stdlib/string/format' );
6060
* var y = array( new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ) );
6161
*
6262
* var z = ddot( x, y );
63-
* // returns <ndarray>
64-
*
65-
* var v = z.get();
66-
* // returns -5.0
63+
* // returns <ndarray>[ -5.0 ]
6764
*/
6865
function ddot( x, y ) {
6966
var dim;

0 commit comments

Comments
 (0)