Skip to content

Commit e83179b

Browse files
authored
docs: improve doctests for complex number instances in math/base/special/cceilf
PR-URL: #10183 Ref: #8641 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent 51c43ad commit e83179b

File tree

6 files changed

+6
-50
lines changed

6 files changed

+6
-50
lines changed

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

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,9 @@ Rounds each component of a single-precision complex floating-point number toward
3636

3737
```javascript
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 = cceilf( new Complex64( -1.5, 2.5 ) );
43-
// returns <Complex64>
44-
45-
var re = real( v );
46-
// returns -1.0
47-
48-
var im = imag( v );
49-
// returns 3.0
41+
// returns <Complex64>[ -1.0, 3.0 ]
5042
```
5143

5244
</section>

lib/node_modules/@stdlib/math/base/special/cceilf/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/float32/ctor}}( -1.5, 2.5 ) )
19-
<Complex64>
20-
> var re = {{alias:@stdlib/complex/float32/real}}( v )
21-
-1.0
22-
> var im = {{alias:@stdlib/complex/float32/imag}}( v )
23-
3.0
19+
<Complex64>[ -1.0, 3.0 ]
2420

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

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

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

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

4234
// MODULES //

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

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

lib/node_modules/@stdlib/math/base/special/cceilf/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 Complex64 = require( '@stdlib/complex/float32/ctor' );
38-
* var realf = require( '@stdlib/complex/float32/real' );
39-
* var imagf = require( '@stdlib/complex/float32/imag' );
4038
*
4139
* var v = cceilf( new Complex64( -1.5, 2.5 ) );
42-
* // returns <Complex64>
43-
*
44-
* var re = realf( v );
45-
* // returns -1.0
46-
*
47-
* var im = imagf( v );
48-
* // returns 3.0
40+
* // returns <Complex64>[ -1.0, 3.0 ]
4941
*/
5042
function cceilf( z ) {
5143
var v = addon( z );

0 commit comments

Comments
 (0)