Skip to content

Commit 0909988

Browse files
authored
docs: improve doctests for complex number instances in math/base/special/cflipsignf
PR-URL: #9011 Ref: #8641 Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent 0b2faa8 commit 0909988

File tree

6 files changed

+6
-50
lines changed

6 files changed

+6
-50
lines changed

lib/node_modules/@stdlib/math/base/special/cflipsignf/README.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,17 +46,9 @@ Returns a single-precision complex floating-point number with the same magnitude
4646

4747
```javascript
4848
var Complex64 = require( '@stdlib/complex/float32/ctor' );
49-
var real = require( '@stdlib/complex/float32/real' );
50-
var imag = require( '@stdlib/complex/float32/imag' );
5149

5250
var v = cflipsignf( new Complex64( -4.0, 5.0 ), -1.0 );
53-
// returns <Complex64>
54-
55-
var re = real( v );
56-
// returns 4.0
57-
58-
var im = imag( v );
59-
// returns -5.0
51+
// returns <Complex64>[ 4.0, -5.0 ]
6052
```
6153

6254
</section>

lib/node_modules/@stdlib/math/base/special/cflipsignf/docs/repl.txt

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,7 @@
1919
Examples
2020
--------
2121
> var v = {{alias}}( new {{alias:@stdlib/complex/float32/ctor}}( -4.0, 5.0 ), -9.0 )
22-
<Complex64>
23-
> var re = {{alias:@stdlib/complex/float32/real}}( v )
24-
4.0
25-
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
26-
-5.0
22+
<Complex64>[ 4.0, -5.0 ]
2723

2824
See Also
2925
--------

lib/node_modules/@stdlib/math/base/special/cflipsignf/docs/types/index.d.ts

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,9 @@ import { Complex64 } from '@stdlib/types/complex';
3131
*
3232
* @example
3333
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
34-
* var real = require( '@stdlib/complex/float32/real' );
35-
* var imag = require( '@stdlib/complex/float32/imag' );
3634
*
3735
* var v = cflipsignf( new Complex64( -4.0, 5.0 ), -55.0 );
38-
* // returns <Complex64>
39-
*
40-
* var re = real( v );
41-
* // returns 4.0
42-
*
43-
* var im = imag( v );
44-
* // returns -5.0
36+
* // returns <Complex64>[ 4.0, -5.0 ]
4537
*/
4638
declare function cflipsignf( z: Complex64, y: number ): Complex64;
4739

lib/node_modules/@stdlib/math/base/special/cflipsignf/lib/index.js

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,10 @@
2525
*
2626
* @example
2727
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
28-
* var real = require( '@stdlib/complex/float32/real' );
29-
* var imag = require( '@stdlib/complex/float32/imag' );
3028
* var cflipsignf = require( '@stdlib/math/base/special/cflipsignf' );
3129
*
3230
* var v = cflipsignf( new Complex64( -4.0, 5.0 ), -55.0 );
33-
* // returns <Complex64>
34-
*
35-
* var re = real( v );
36-
* // returns 4.0
37-
*
38-
* var im = imag( v );
39-
* // returns -5.0
31+
* // returns <Complex64>[ 4.0, -5.0 ]
4032
*/
4133

4234
// MODULES //

lib/node_modules/@stdlib/math/base/special/cflipsignf/lib/main.js

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,9 @@ var imagf = require( '@stdlib/complex/float32/imag' );
3737
*
3838
* @example
3939
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
40-
* var realf = require( '@stdlib/complex/float32/real' );
41-
* var imagf = require( '@stdlib/complex/float32/imag' );
4240
*
4341
* var v = cflipsignf( new Complex64( -4.0, 5.0 ), -55.0 );
44-
* // returns <Complex64>
45-
*
46-
* var re = realf( v );
47-
* // returns 4.0
48-
*
49-
* var im = imagf( v );
50-
* // returns -5.0
42+
* // returns <Complex64>[ 4.0, -5.0 ]
5143
*/
5244
function cflipsignf( z, y ) {
5345
var re = realf( z );

lib/node_modules/@stdlib/math/base/special/cflipsignf/lib/native.js

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,9 @@ var addon = require( './../src/addon.node' );
3636
*
3737
* @example
3838
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
39-
* var real = require( '@stdlib/complex/float32/real' );
40-
* var imag = require( '@stdlib/complex/float32/imag' );
4139
*
4240
* var v = cflipsignf( new Complex64( -4.0, 5.5 ), -55.0 );
43-
* // returns <Complex64>
44-
*
45-
* var re = real( v );
46-
* // returns 4.0
47-
*
48-
* var im = imag( v );
49-
* // returns -5.5
41+
* // returns <Complex64>[ 4.0, -5.5 ]
5042
*/
5143
function cflipsignf( z, y ) {
5244
var v = addon( z, y );

0 commit comments

Comments
 (0)