Skip to content

Commit 767edc7

Browse files
aryan7071kgryte
andauthored
docs: improve doctests in complex/base/wrap-function
PR-URL: #8666 Ref: #8641 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent d07452d commit 767edc7

File tree

6 files changed

+10
-68
lines changed

6 files changed

+10
-68
lines changed

lib/node_modules/@stdlib/complex/base/wrap-function/README.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -86,24 +86,16 @@ The function accepts the following arguments:
8686
```javascript
8787
var Complex64 = require( '@stdlib/complex/float32/ctor' );
8888
var caddf = require( '@stdlib/complex/float32/base/add' );
89-
var realf = require( '@stdlib/complex/float32/real' );
90-
var imagf = require( '@stdlib/complex/float32/imag' );
9189
var wrap = require( '@stdlib/complex/base/wrap-function' );
9290

9391
var f = wrap( caddf, 2, Complex64 );
9492

9593
// ...
9694

9795
var z = f( 3.0, 4.0 );
98-
// returns <Complex64>
96+
// returns <Complex64>[ 7.0, 0.0 ]
9997

100-
var re = realf( z );
101-
// returns 7.0
102-
103-
var im = imagf( z );
104-
// returns 0.0
105-
106-
console.log( '%d + %di', re, im );
98+
console.log( z.toString() );
10799
// => '7 + 0i'
108100
```
109101

lib/node_modules/@stdlib/complex/base/wrap-function/docs/repl.txt

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,7 @@
3636
--------
3737
> var f = {{alias}}( {{alias:@stdlib/complex/float32/base/add}}, 2, {{alias:@stdlib/complex/float32/ctor}} );
3838
> var z = f( 3.0, 4.0 )
39-
<Complex64>
40-
> var re = {{alias:@stdlib/complex/float32/real}}( z )
41-
7.0
42-
> var im = {{alias:@stdlib/complex/float32/imag}}( z )
43-
0.0
39+
<Complex64>[ 7.0, 0.0 ]
4440

4541
See Also
4642
--------

lib/node_modules/@stdlib/complex/base/wrap-function/docs/types/index.d.ts

Lines changed: 3 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -193,13 +193,7 @@ type Constructor = new( re: number, im: number ) => ComplexLike;
193193
* // ...
194194
*
195195
* var z = f();
196-
* // returns <Complex64>
197-
*
198-
* var re = realf( z );
199-
* // returns <number>
200-
*
201-
* var im = imagf( z );
202-
* // returns <number>
196+
* // e.g., returns <Complex64>[ <number>, <number> ]
203197
*/
204198
declare function wrap( fcn: Nullary, nargs: 0, ctor: Constructor ): Nullary;
205199

@@ -220,21 +214,13 @@ declare function wrap( fcn: Nullary, nargs: 0, ctor: Constructor ): Nullary;
220214
* @example
221215
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
222216
* var cidentityf = require( '@stdlib/complex/float32/base/identity' );
223-
* var realf = require( '@stdlib/complex/float32/real' );
224-
* var imagf = require( '@stdlib/complex/float32/imag' );
225217
*
226218
* var f = wrap( cidentityf, 1, Complex64 );
227219
*
228220
* // ...
229221
*
230222
* var z = f( 3.0 );
231-
* // returns <Complex64>
232-
*
233-
* var re = realf( z );
234-
* // returns 3.0
235-
*
236-
* var im = imagf( z );
237-
* // returns 0.0
223+
* // returns <Complex64>[ 3.0, 0.0 ]
238224
*/
239225
declare function wrap( fcn: Unary, nargs: 1, ctor: Constructor ): WrappedUnary;
240226

@@ -255,21 +241,13 @@ declare function wrap( fcn: Unary, nargs: 1, ctor: Constructor ): WrappedUnary;
255241
* @example
256242
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
257243
* var caddf = require( '@stdlib/complex/float32/base/add' );
258-
* var realf = require( '@stdlib/complex/float32/real' );
259-
* var imagf = require( '@stdlib/complex/float32/imag' );
260244
*
261245
* var f = wrap( caddf, 2, Complex64 );
262246
*
263247
* // ...
264248
*
265249
* var z = f( 3.0, 4.0 );
266-
* // returns <Complex64>
267-
*
268-
* var re = realf( z );
269-
* // returns 7.0
270-
*
271-
* var im = imagf( z );
272-
* // returns 0.0
250+
* // returns <Complex64>[ 7.0, 0.0 ]
273251
*/
274252
declare function wrap( fcn: Binary, nargs: 2, ctor: Constructor ): WrappedBinary;
275253

lib/node_modules/@stdlib/complex/base/wrap-function/examples/index.js

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,14 @@
2020

2121
var Complex64 = require( '@stdlib/complex/float32/ctor' );
2222
var caddf = require( '@stdlib/complex/float32/base/add' );
23-
var realf = require( '@stdlib/complex/float32/real' );
24-
var imagf = require( '@stdlib/complex/float32/imag' );
2523
var wrap = require( './../lib' );
2624

2725
var f = wrap( caddf, 2, Complex64 );
2826

2927
// ...
3028

3129
var z = f( 3.0, 4.0 );
32-
// returns <Complex64>
30+
// returns <Complex64>[ 7.0, 0.0 ]
3331

34-
var re = realf( z );
35-
// returns 7.0
36-
37-
var im = imagf( z );
38-
// returns 0.0
39-
40-
console.log( '%d + %di', re, im );
32+
console.log( z.toString() );
4133
// => '7 + 0i'

lib/node_modules/@stdlib/complex/base/wrap-function/lib/index.js

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,22 +26,14 @@
2626
* @example
2727
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
2828
* var caddf = require( '@stdlib/complex/float32/base/add' );
29-
* var realf = require( '@stdlib/complex/float32/real' );
30-
* var imagf = require( '@stdlib/complex/float32/imag' );
3129
* var wrap = require( '@stdlib/complex/base/wrap-function' );
3230
*
3331
* var f = wrap( caddf, 2, Complex64 );
3432
*
3533
* // ...
3634
*
3735
* var z = f( 3.0, 4.0 );
38-
* // returns <Complex64>
39-
*
40-
* var re = realf( z );
41-
* // returns 7.0
42-
*
43-
* var im = imagf( z );
44-
* // returns 0.0
36+
* // returns <Complex64>[ 7.0, 0.0 ]
4537
*/
4638

4739
// MODULES //

lib/node_modules/@stdlib/complex/base/wrap-function/lib/main.js

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,21 +53,13 @@ var T = 'number';
5353
* @example
5454
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
5555
* var caddf = require( '@stdlib/complex/float32/base/add' );
56-
* var realf = require( '@stdlib/complex/float32/real' );
57-
* var imagf = require( '@stdlib/complex/float32/imag' );
5856
*
5957
* var f = wrap( caddf, 2, Complex64 );
6058
*
6159
* // ...
6260
*
6361
* var z = f( 3.0, 4.0 );
64-
* // returns <Complex64>
65-
*
66-
* var re = realf( z );
67-
* // returns 7.0
68-
*
69-
* var im = imagf( z );
70-
* // returns 0.0
62+
* // returns <Complex64>[ 7.0, 0.0 ]
7163
*/
7264
function wrap( fcn, nargs, ctor ) {
7365
var fcns;

0 commit comments

Comments
 (0)