Skip to content

Commit 32cb1a3

Browse files
docs: improve doctests for ndarray instances in ndarray/concat1d
PR-URL: #9344 Ref: #9329 Reviewed-by: Athan Reines <[email protected]>
1 parent b6b70c7 commit 32cb1a3

File tree

5 files changed

+11
-46
lines changed

5 files changed

+11
-46
lines changed

lib/node_modules/@stdlib/ndarray/concat1d/README.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -46,16 +46,12 @@ Returns a one-dimensional [ndarray][@stdlib/ndarray/ctor] formed by concatenatin
4646

4747
```javascript
4848
var array = require( '@stdlib/ndarray/array' );
49-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
5049

5150
var x = array( [ -1.0, 2.0, 3.0, 4.0 ] );
5251
var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );
5352

5453
var out = concat1d( x, y );
55-
// returns <ndarray>
56-
57-
var arr = ndarray2array( out );
58-
// returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
54+
// returns <ndarray>[ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
5955
```
6056

6157
The function accepts the following arguments:
@@ -71,20 +67,16 @@ Concatenates provided input arguments and assigns the result to a provided one-d
7167
```javascript
7268
var array = require( '@stdlib/ndarray/array' );
7369
var zeros = require( '@stdlib/ndarray/zeros' );
74-
var ndarray2array = require( '@stdlib/ndarray/to-array' );
7570

7671
var x = array( [ -1.0, 2.0, 3.0, 4.0 ] );
7772
var y = array( [ -5.0, 6.0, -7.0, -8.0 ] );
7873
var z = zeros( [ 8 ] );
7974

8075
var out = concat1d.assign( x, y, z );
81-
// returns <ndarray>
76+
// returns <ndarray>[ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0 ]
8277

8378
var bool = ( out === z );
8479
// returns true
85-
86-
var arr = ndarray2array( z );
87-
// returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0 ]
8880
```
8981

9082
The function accepts the following arguments:

lib/node_modules/@stdlib/ndarray/concat1d/docs/types/index.d.ts

Lines changed: 6 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,7 @@ interface Concat1d {
4646
* var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );
4747
*
4848
* var out = concat1d( x, y );
49-
* // returns <ndarray>
50-
*
51-
* var arr = ndarray2array( out );
52-
* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
49+
* // returns <ndarray>[ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
5350
*/
5451
<T = unknown>( arrays: Array<Input<T>> ): typedndarray<T>; // FIXME: this is a tricky one to type correctly, as the actual output dtype depends on type promotion rules
5552

@@ -68,10 +65,7 @@ interface Concat1d {
6865
* var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );
6966
*
7067
* var out = concat1d( x, y );
71-
* // returns <ndarray>
72-
*
73-
* var arr = ndarray2array( out );
74-
* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
68+
* // returns <ndarray>[ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
7569
*/
7670
<T = unknown>( arg: Input<T>, ...arrays: Array<Input<T>> ): typedndarray<T>; // FIXME: this is a tricky one to type correctly, as the actual output dtype depends on type promotion rules
7771

@@ -92,13 +86,10 @@ interface Concat1d {
9286
* var z = empty( [ 10 ] );
9387
*
9488
* var out = concat1d.assign( [ x, y ], z );
95-
* // returns <ndarray>
89+
* // returns <ndarray>[ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
9690
*
9791
* var bool = ( out === z );
9892
* // returns true
99-
*
100-
* var arr = ndarray2array( z );
101-
* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
10293
*/
10394
assign<T = unknown, U = unknown, V extends typedndarray<U> = typedndarray<U>>( args: ArrayLike<Input<T>>, out: V ): V;
10495

@@ -121,13 +112,10 @@ interface Concat1d {
121112
* var z = empty( [ 10 ] );
122113
*
123114
* var out = concat1d.assign( x, y, z );
124-
* // returns <ndarray>
115+
* // returns <ndarray>[ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
125116
*
126117
* var bool = ( out === z );
127118
* // returns true
128-
*
129-
* var arr = ndarray2array( z );
130-
* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
131119
*/
132120
assign<T = unknown, U = unknown, V extends typedndarray<U> = typedndarray<U>>( arg1: Input<T>, arg2: Input<T> | V, ...args: Array<Input<T> | V> ): V; // FIXME: in order to more robustly return a correct output type here, we'd likely need to use overloads with varying arity. The issue here is that `V` needs to be the last argument, which is not captured here.
133121
}
@@ -146,10 +134,7 @@ interface Concat1d {
146134
* var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );
147135
*
148136
* var out = concat1d( x, y );
149-
* // returns <ndarray>
150-
*
151-
* var arr = ndarray2array( out );
152-
* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
137+
* // returns <ndarray>[ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
153138
*
154139
* @example
155140
* var array = require( '@stdlib/ndarray/array' );
@@ -161,13 +146,10 @@ interface Concat1d {
161146
* var z = empty( [ 10 ] );
162147
*
163148
* var out = concat1d.assign( [ x, y ], z );
164-
* // returns <ndarray>
149+
* // returns <ndarray>[ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
165150
*
166151
* var bool = ( out === z );
167152
* // returns true
168-
*
169-
* var arr = ndarray2array( z );
170-
* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
171153
*/
172154
declare var concat1d: Concat1d;
173155

lib/node_modules/@stdlib/ndarray/concat1d/lib/assign.js

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,10 @@ var DEFAULT_DTYPE = defaults.get( 'dtypes.default' );
6060
* var z = empty( [ 10 ] );
6161
*
6262
* var out = assign( x, y, z );
63-
* // returns <ndarray>
63+
* // returns <ndarray>[ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
6464
*
6565
* var bool = ( out === z );
6666
* // returns true
67-
*
68-
* var arr = ndarray2array( z );
69-
* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
7067
*/
7168
function assign() {
7269
var nargs;

lib/node_modules/@stdlib/ndarray/concat1d/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( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );
3333
*
3434
* var out = concat1d( x, y );
35-
* // returns <ndarray>
36-
*
37-
* var arr = ndarray2array( out );
38-
* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
35+
* // returns <ndarray>[ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
3936
*/
4037

4138
// MODULES //

lib/node_modules/@stdlib/ndarray/concat1d/lib/main.js

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,7 @@ var DEFAULT_DTYPE = defaults.get( 'dtypes.default' );
5656
* var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );
5757
*
5858
* var out = concat1d( x, y );
59-
* // returns <ndarray>
60-
*
61-
* var arr = ndarray2array( out );
62-
* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
59+
* // returns <ndarray>[ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
6360
*/
6461
function concat1d() {
6562
var nargs;

0 commit comments

Comments
 (0)