Skip to content

Commit c970ea2

Browse files
authored
docs: improve doctests for complex number instances in math/base/special/cceil (#9007)
1 parent 512334c commit c970ea2

File tree

5 files changed

+5
-41
lines changed

5 files changed

+5
-41
lines changed

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,7 @@
1616
Examples
1717
--------
1818
> var v = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( -1.5, 2.5 ) )
19-
<Complex128>
20-
> var re = {{alias:@stdlib/complex/float64/real}}( v )
21-
-1.0
22-
> var im = {{alias:@stdlib/complex/float64/imag}}( v )
23-
3.0
19+
<Complex128>[ -1.0, 3.0 ]
2420

2521
See Also
2622
--------

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

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,9 @@ import { Complex128 } from '@stdlib/types/complex';
3030
*
3131
* @example
3232
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
33-
* var real = require( '@stdlib/complex/float64/real' );
34-
* var imag = require( '@stdlib/complex/float64/imag' );
3533
*
3634
* var v = cceil( new Complex128( -1.5, 2.5 ) );
37-
* // returns <Complex128>
38-
*
39-
* var re = real( v );
40-
* // returns -1.0
41-
*
42-
* var im = imag( v );
43-
* // returns 3.0
35+
* // returns <Complex128>[ -1.0, 3.0 ]
4436
*/
4537
declare function cceil( z: Complex128 ): Complex128;
4638

lib/node_modules/@stdlib/math/base/special/cceil/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 Complex128 = require( '@stdlib/complex/float64/ctor' );
28-
* var real = require( '@stdlib/complex/float64/real' );
29-
* var imag = require( '@stdlib/complex/float64/imag' );
3028
* var cceil = require( '@stdlib/math/base/special/cceil' );
3129
*
3230
* var v = cceil( new Complex128( -1.5, 2.5 ) );
33-
* // returns <Complex128>
34-
*
35-
* var re = real( v );
36-
* // returns -1.0
37-
*
38-
* var im = imag( v );
39-
* // returns 3.0
31+
* // returns <Complex128>[ -1.0, 3.0 ]
4032
*/
4133

4234
// MODULES //

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

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,9 @@ var imag = require( '@stdlib/complex/float64/imag' );
3636
*
3737
* @example
3838
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
39-
* var real = require( '@stdlib/complex/float64/real' );
40-
* var imag = require( '@stdlib/complex/float64/imag' );
4139
*
4240
* var v = cceil( new Complex128( -1.5, 2.5 ) );
43-
* // returns <Complex128>
44-
*
45-
* var re = real( v );
46-
* // returns -1.0
47-
*
48-
* var im = imag( v );
49-
* // returns 3.0
41+
* // returns <Complex128>[ -1.0, 3.0 ]
5042
*/
5143
function cceil( z ) {
5244
return new Complex128( ceil( real( z ) ), ceil( imag( z ) ) );

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

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,9 @@ var addon = require( './../src/addon.node' );
3535
*
3636
* @example
3737
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
38-
* var real = require( '@stdlib/complex/float64/real' );
39-
* var imag = require( '@stdlib/complex/float64/imag' );
4038
*
4139
* var v = cceil( new Complex128( -1.5, 2.5 ) );
42-
* // returns <Complex128>
43-
*
44-
* var re = real( v );
45-
* // returns -1.0
46-
*
47-
* var im = imag( v );
48-
* // returns 3.0
40+
* // returns <Complex128>[ -1.0, 3.0 ]
4941
*/
5042
function cceil( z ) {
5143
var v = addon( z );

0 commit comments

Comments
 (0)