Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-12-07)
+## Unreleased (2025-12-12)
 
 <section class="features">
 
@@ -708,6 +708,7 @@ A total of 73 issues were closed in this release:
 
 <details>
 
+-   [`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)_
@@ -1834,12 +1835,13 @@ A total of 73 issues were closed in this release:
 
 ### Contributors
 
-A total of 54 people contributed to this release. Thank you to the following contributors:
+A total of 55 people contributed to this release. Thank you to the following contributors:
 
 -   Aayush Khanna
 -   Aman Singh
 -   Anmol Sah
 -   Anshu Kumar
+-   Aryan kumar
 -   Athan Reines
 -   Atharva Patil
 -   Devshree Bhati

base/special/csignum/README.md

@@ -46,35 +46,15 @@ Evaluates the [signum][signum] function of a double-precision complex floating-p
 
 ```javascript
 var Complex128 = require( '@stdlib/complex/float64/ctor' );
-var real = require( '@stdlib/complex/float64/real' );
-var imag = require( '@stdlib/complex/float64/imag' );
 
 var v = csignum( new Complex128( -4.2, 5.5 ) );
-// returns <Complex128>
-
-var re = real( v );
-// returns -0.6069136033622302
-
-var im = imag( v );
-// returns 0.79476781392673
+// returns <Complex128>[ -0.6069136033622302, 0.79476781392673 ]
 
 v = csignum( new Complex128( 0.0, 0.0 ) );
-// returns <Complex128>
-
-re = real( v );
-// returns 0.0
-
-im = imag( v );
-// returns 0.0
+// returns <Complex128>[ 0.0, 0.0 ]
 
 v = csignum( new Complex128( NaN, NaN ) );
-// returns <Complex128>
-
-re = real( v );
-// returns NaN
-
-im = imag( v );
-// returns NaN
+// returns <Complex128>[ NaN, NaN ]
 ```
 
 </section>

base/special/csignum/docs/repl.txt

@@ -16,11 +16,7 @@
     Examples
     --------
     > var v = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( -4.2, 5.5 ) )
-    <Complex128>
-    > var re = {{alias:@stdlib/complex/float64/real}}( v )
-    -0.6069136033622302
-    > var im = {{alias:@stdlib/complex/float64/imag}}( v )
-    0.79476781392673
+    <Complex128>[ -0.6069136033622302, 0.79476781392673 ]
 
     See Also
     --------

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

@@ -30,17 +30,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 = csignum( new Complex128( -4.2, 5.5 ) );
-* // returns <Complex128>
-*
-* var re = real( v );
-* // returns -0.6069136033622302
-*
-* var im = imag( v );
-* // returns 0.79476781392673
+* // returns <Complex128>[ -0.6069136033622302, 0.79476781392673 ]
 */
 declare function csignum( z: Complex128 ): Complex128;
 

base/special/csignum/lib/index.js

@@ -25,36 +25,16 @@
 *
 * @example
 * var Complex128 = require( '@stdlib/complex/float64/ctor' );
-* var real = require( '@stdlib/complex/float64/real' );
-* var imag = require( '@stdlib/complex/float64/imag' );
 * var csignum = require( '@stdlib/math/base/special/csignum' );
 *
 * var v = csignum( new Complex128( -4.2, 5.5 ) );
-* // returns <Complex128>
-*
-* var re = real( v );
-* // returns -0.6069136033622302
-*
-* var im = imag( v );
-* // returns 0.79476781392673
+* // returns <Complex128>[ -0.6069136033622302, 0.79476781392673 ]
 *
 * v = csignum( new Complex128( 0.0, 0.0 ) );
-* // returns <Complex128>
-*
-* re = real( v );
-* // returns 0.0
-*
-* im = imag( v );
-* // returns 0.0
+* // returns <Complex128>[ 0.0, 0.0 ]
 *
 * v = csignum( new Complex128( NaN, NaN ) );
-* // returns <Complex128>
-*
-* re = real( v );
-* // returns NaN
-*
-* im = imag( v );
-* // returns NaN
+* // returns <Complex128>[ NaN, NaN ]
 */
 
 // MODULES //

base/special/csignum/lib/main.js

@@ -36,35 +36,15 @@ var cabs = require( './../../../../base/special/cabs' );
 *
 * @example
 * var Complex128 = require( '@stdlib/complex/float64/ctor' );
-* var real = require( '@stdlib/complex/float64/real' );
-* var imag = require( '@stdlib/complex/float64/imag' );
 *
 * var v = csignum( new Complex128( -4.2, 5.5 ) );
-* // returns <Complex128>
-*
-* var re = real( v );
-* // returns -0.6069136033622302
-*
-* var im = imag( v );
-* // returns 0.79476781392673
+* // returns <Complex128>[ -0.6069136033622302, 0.79476781392673 ]
 *
 * v = csignum( new Complex128( 0.0, 0.0 ) );
-* // returns <Complex128>
-*
-* re = real( v );
-* // returns 0.0
-*
-* im = imag( v );
-* // returns 0.0
+* // returns <Complex128>[ 0.0, 0.0 ]
 *
 * v = csignum( new Complex128( NaN, NaN ) );
-* // returns <Complex128>
-*
-* re = real( v );
-* // returns NaN
-*
-* im = imag( v );
-* // returns NaN
+* // returns <Complex128>[ NaN, NaN ]
 */
 function csignum( z ) {
 	var re;

base/special/csignum/lib/native.js

@@ -35,35 +35,15 @@ 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 = csignum( new Complex128( -4.2, 5.5 ) );
-* // returns <Complex128>
-*
-* var re = real( v );
-* // returns -0.6069136033622302
-*
-* var im = imag( v );
-* // returns 0.79476781392673
+* // returns <Complex128>[ -0.6069136033622302, 0.79476781392673 ]
 *
 * v = csignum( new Complex128( 0.0, 0.0 ) );
-* // returns <Complex128>
-*
-* re = real( v );
-* // returns 0.0
-*
-* im = imag( v );
-* // returns 0.0
+* // returns <Complex128>[ 0.0, 0.0 ]
 *
 * v = csignum( new Complex128( NaN, NaN ) );
-* // returns <Complex128>
-*
-* re = real( v );
-* // returns NaN
-*
-* im = imag( v );
-* // returns NaN
+* // returns <Complex128>[ NaN, NaN ]
 */
 function csignum( z ) {
 	var v = addon( z );