Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -708,10 +708,11 @@ A total of 73 issues were closed in this release:
 
 <details>
 
--   [`c970ea2`](https://github.com/stdlib-js/stdlib/commit/c970ea241b28901fb006bb39f484384d581ae9b8) - **docs:** improve doctests for complex number instances in `math/base/special/cceil` (#9007) _(by Aryan kumar)_
+-   [`f3a591e`](https://github.com/stdlib-js/stdlib/commit/f3a591e3fcf19bdf10a7930c9d01792bd266dfba) - **docs:** improve doctests for complex number instances in `math/base/special/croundn` [(#9008)](https://github.com/stdlib-js/stdlib/pull/9008) _(by Aryan kumar)_
+-   [`c970ea2`](https://github.com/stdlib-js/stdlib/commit/c970ea241b28901fb006bb39f484384d581ae9b8) - **docs:** improve doctests for complex number instances in `math/base/special/cceil` [(#9007)](https://github.com/stdlib-js/stdlib/pull/9007) _(by Aryan kumar)_
 -   [`512334c`](https://github.com/stdlib-js/stdlib/commit/512334c49e27ddff4e3fa672e1e81ac2c4fbc123) - **docs:** improve doctests for complex number instances in `math/base/special/ccis` [(#9014)](https://github.com/stdlib-js/stdlib/pull/9014) _(by Aryan kumar)_
--   [`0909988`](https://github.com/stdlib-js/stdlib/commit/09099888c7fbd7d723a0c466e2f8d317a5e7c3a1) - **docs:** improve doctests for complex number instances in math/base/special/cflipsignf [(#9011)](https://github.com/stdlib-js/stdlib/pull/9011) _(by Aryan kumar)_
--   [`0b2faa8`](https://github.com/stdlib-js/stdlib/commit/0b2faa8e50b543fa573577cb0baaada5ddd20297) - **docs:** improve doctests for complex number instances in math/base/special/csignum [(#9012)](https://github.com/stdlib-js/stdlib/pull/9012) _(by Aryan kumar)_
+-   [`0909988`](https://github.com/stdlib-js/stdlib/commit/09099888c7fbd7d723a0c466e2f8d317a5e7c3a1) - **docs:** improve doctests for complex number instances in `math/base/special/cflipsignf` [(#9011)](https://github.com/stdlib-js/stdlib/pull/9011) _(by Aryan kumar)_
+-   [`0b2faa8`](https://github.com/stdlib-js/stdlib/commit/0b2faa8e50b543fa573577cb0baaada5ddd20297) - **docs:** improve doctests for complex number instances in `math/base/special/csignum` [(#9012)](https://github.com/stdlib-js/stdlib/pull/9012) _(by Aryan kumar)_
 -   [`9c412c7`](https://github.com/stdlib-js/stdlib/commit/9c412c7a96d4b5381cda9be8c83f4e701155fe95) - **docs:** update related packages sections [(#8860)](https://github.com/stdlib-js/stdlib/pull/8860) _(by stdlib-bot, Athan Reines)_
 -   [`e7fbc24`](https://github.com/stdlib-js/stdlib/commit/e7fbc24f9fb918a92f7e9118fbe9fed8573117c8) - **docs:** fix example code in TSDoc declaration _(by Philipp Burckhardt)_
 -   [`ed42a4f`](https://github.com/stdlib-js/stdlib/commit/ed42a4f20e80757e6e855dc9ac4e70ab5a28f423) - **docs:** update related packages sections [(#8835)](https://github.com/stdlib-js/stdlib/pull/8835) _(by stdlib-bot)_

base/special/croundn/README.md

@@ -36,44 +36,18 @@ Rounds each component of a double-precision complex floating-point number to the
 
 ```javascript
 var Complex128 = require( '@stdlib/complex/float64/ctor' );
-var real = require( '@stdlib/complex/float64/real' );
-var imag = require( '@stdlib/complex/float64/imag' );
 
 var v = croundn( new Complex128( -3.141592653589793, 3.141592653589793 ), -2 );
-// returns <Complex128>
-
-var re = real( v );
-// returns -3.14
-
-var im = imag( v );
-// returns 3.14
+// returns <Complex128>[ -3.14, 3.14 ]
 
 v = croundn( new Complex128( -3.141592653589793, 3.141592653589793 ), 0 );
-// returns <Complex128>
-
-re = real( v );
-// returns -3.0
-
-im = imag( v );
-// returns 3.0
+// returns <Complex128>[ -3.0, 3.0 ]
 
 v = croundn( new Complex128( -12368.0, 12368.0 ), 3 );
-// returns <Complex128>
-
-re = real( v );
-// returns -12000.0
-
-im = imag( v );
-// returns 12000.0
+// returns <Complex128>[ -12000.0, 12000.0 ]
 
 v = croundn( new Complex128( NaN, NaN ), 3 );
-// returns <Complex128>
-
-re = real( v );
-// returns NaN
-
-im = imag( v );
-// returns NaN
+// returns <Complex128>[ NaN, NaN ]
 ```
 
 </section>
@@ -88,21 +62,13 @@ im = imag( v );
 
     ```javascript
     var Complex128 = require( '@stdlib/complex/float64/ctor' );
-    var real = require( '@stdlib/complex/float64/real' );
-    var imag = require( '@stdlib/complex/float64/imag' );
 
     var x = 0.2 + 0.1;
     // returns 0.30000000000000004
 
     // Should round components to 0.3:
     var v = croundn( new Complex128( x, x ), -16 );
-    // returns <Complex128>
-
-    var re = real( v );
-    // returns 0.3000000000000001
-
-    var im = imag( v );
-    // returns 0.3000000000000001
+    // returns <Complex128>[ 0.3000000000000001, 0.3000000000000001 ]
     ```
 
 </section>

base/special/croundn/docs/repl.txt

@@ -22,11 +22,7 @@
     Examples
     --------
     > var v = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( 5.555, -3.336 ), -2 )
-    <Complex128>
-    > var re = {{alias:@stdlib/complex/float64/real}}( v )
-    5.56
-    > var im = {{alias:@stdlib/complex/float64/imag}}( v )
-    -3.34
+    <Complex128>[ 5.56, -3.34 ]
 
     See Also
     --------

base/special/croundn/docs/types/index.d.ts

@@ -35,17 +35,9 @@ import { Complex128 } from '@stdlib/types/complex';
 *
 * @example
 * var Complex128 = require( '@stdlib/complex/float64/ctor' );
-* var real = require( '@stdlib/complex/float64/real' );
-* var imag = require( '@stdlib/complex/float64/imag' );
 *
 * var v = croundn( new Complex128( 5.555, -3.333 ), -2 );
-* // returns <Complex128>
-*
-* var re = real( v );
-* // returns 5.56
-*
-* var im = imag( v );
-* // returns -3.33
+* // returns <Complex128>[ 5.56, -3.33 ]
 */
 declare function croundn( z: Complex128, n: number ): Complex128;
 

base/special/croundn/lib/index.js

@@ -25,47 +25,21 @@
 *
 * @example
 * var Complex128 = require( '@stdlib/complex/float64/ctor' );
-* var real = require( '@stdlib/complex/float64/real' );
-* var imag = require( '@stdlib/complex/float64/imag' );
 * var croundn = require( '@stdlib/math/base/special/croundn' );
 *
 * var v = croundn( new Complex128( -3.141592653589793, 3.141592653589793 ), -2 );
-* // returns <Complex128>
-*
-* var re = real( v );
-* // returns -3.14
-*
-* var im = imag( v );
-* // returns 3.14
+* // returns <Complex128>[ -3.14, 3.14 ]
 *
 * // If n = 0, `croundn` behaves like `cround`:
 * v = croundn( new Complex128( 9.99999, 0.1 ), 0 );
-* // returns <Complex128>
-*
-* re = real( v );
-* // returns 10.0
-*
-* im = imag( v );
-* // returns 0.0
+* // returns <Complex128>[ 10.0, 0.0 ]
 *
 * // Round components to the nearest thousand:
 * v = croundn( new Complex128( 12368.0, -12368.0 ), 3 );
-* // returns <Complex128>
-*
-* re = real( v );
-* // returns 12000.0
-*
-* im = imag( v );
-* // returns -12000.0
+* // returns <Complex128>[ 12000.0, -12000.0 ]
 *
 * v = croundn( new Complex128( NaN, NaN ), 2 );
-* // returns <Complex128>
-*
-* re = real( v );
-* // returns NaN
-*
-* im = imag( v );
-* // returns NaN
+* // returns <Complex128>[ NaN, NaN ]
 */
 
 // MODULES //

base/special/croundn/lib/main.js

@@ -37,46 +37,20 @@ var imag = require( '@stdlib/complex/float64/imag' );
 *
 * @example
 * var Complex128 = require( '@stdlib/complex/float64/ctor' );
-* var real = require( '@stdlib/complex/float64/real' );
-* var imag = require( '@stdlib/complex/float64/imag' );
 *
 * var v = croundn( new Complex128( -3.141592653589793, 3.141592653589793 ), -2 );
-* // returns <Complex128>
-*
-* var re = real( v );
-* // returns -3.14
-*
-* var im = imag( v );
-* // returns 3.14
+* // returns <Complex128>[ -3.14, 3.14 ]
 *
 * // If n = 0, `croundn` behaves like `cround`:
 * v = croundn( new Complex128( 9.99999, 0.1 ), 0 );
-* // returns <Complex128>
-*
-* re = real( v );
-* // returns 10.0
-*
-* im = imag( v );
-* // returns 0.0
+* // returns <Complex128>[ 10.0, 0.0 ]
 *
 * // Round components to the nearest thousand:
 * v = croundn( new Complex128( 12368.0, -12368.0 ), 3 );
-* // returns <Complex128>
-*
-* re = real( v );
-* // returns 12000.0
-*
-* im = imag( v );
-* // returns -12000.0
+* // returns <Complex128>[ 12000.0, -12000.0 ]
 *
 * v = croundn( new Complex128( NaN, NaN ), 2 );
-* // returns <Complex128>
-*
-* re = real( v );
-* // returns NaN
-*
-* im = imag( v );
-* // returns NaN
+* // returns <Complex128>[ NaN, NaN ]
 */
 function croundn( z, n ) {
 	return new Complex128( roundn( real( z ), n ), roundn( imag( z ), n ) );

base/special/croundn/lib/native.js

@@ -36,46 +36,20 @@ var addon = require( './../src/addon.node' );
 *
 * @example
 * var Complex128 = require( '@stdlib/complex/float64/ctor' );
-* var real = require( '@stdlib/complex/float64/real' );
-* var imag = require( '@stdlib/complex/float64/imag' );
 *
 * var v = croundn( new Complex128( -3.141592653589793, 3.141592653589793 ), -2 );
-* // returns <Complex128>
-*
-* var re = real( v );
-* // returns -3.14
-*
-* var im = imag( v );
-* // returns 3.14
+* // returns <Complex128>[ -3.14, 3.14 ]
 *
 * // If n = 0, `croundn` behaves like `cround`:
 * v = croundn( new Complex128( 9.99999, 0.1 ), 0 );
-* // returns <Complex128>
-*
-* re = real( v );
-* // returns 10.0
-*
-* im = imag( v );
-* // returns 0.0
+* // returns <Complex128>[ 10.0, 0.0 ]
 *
 * // Round components to the nearest thousand:
 * v = croundn( new Complex128( 12368.0, -12368.0 ), 3 );
-* // returns <Complex128>
-*
-* re = real( v );
-* // returns 12000.0
-*
-* im = imag( v );
-* // returns -12000.0
+* // returns <Complex128>[ 12000.0, -12000.0 ]
 *
 * v = croundn( new Complex128( NaN, NaN ), 2 );
-* // returns <Complex128>
-*
-* re = real( v );
-* // returns NaN
-*
-* im = imag( v );
-* // returns NaN
+* // returns <Complex128>[ NaN, NaN ]
 */
 function croundn( z, n ) {
 	var v = addon( z, n );