Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-06-02)
+## Unreleased (2025-06-04)
 
 <section class="features">
 
@@ -22,6 +22,7 @@
 
 <details>
 
+-   [`9bdeea6`](https://github.com/stdlib-js/stdlib/commit/9bdeea6f5229c13589cc191b2f83e89541c26199) - **docs:** update examples for `complex/float64/base/scale` [(#7196)](https://github.com/stdlib-js/stdlib/pull/7196) _(by Shabareesh Shetty)_
 -   [`c705a94`](https://github.com/stdlib-js/stdlib/commit/c705a94eb25e0783437c29a1a9bdb6a41fb09207) - **style:** add missing space [(#7173)](https://github.com/stdlib-js/stdlib/pull/7173) _(by Shabareesh Shetty)_
 -   [`5c8faed`](https://github.com/stdlib-js/stdlib/commit/5c8faed8016941ff5a337bb4d14b1bdb65748993) - **docs:** update example _(by Athan Reines)_
 -   [`a1e230f`](https://github.com/stdlib-js/stdlib/commit/a1e230f29297caa89880e9c194c615a0400fb7bc) - **chore:** clean up cppcheck-suppress comments _(by Karan Anand)_

README.md

@@ -75,19 +75,11 @@ Scales a double-precision complex floating-point number by a real-valued double-
 
 ```javascript
 var Complex128 = require( '@stdlib/complex-float64-ctor' );
-var real = require( '@stdlib/complex-float64-real' );
-var imag = require( '@stdlib/complex-float64-imag' );
 
 var z = new Complex128( 5.0, 3.0 );
 
 var v = scale( 5.0, z );
-// returns <Complex128>
-
-var re = real( v );
-// returns 25.0
-
-var im = imag( v );
-// returns 15.0
+// returns <Complex128>[ 25.0, 15.0 ]
 ```
 
 The function supports the following parameters:

dist/index.js.map

@@ -21,11 +21,7 @@
     > var z = new {{alias:@stdlib/complex/float64/ctor}}( 5.0, 3.0 )
     <Complex128>
     > var out = {{alias}}( 5.0, z )
-    <Complex128>
-    > var re = {{alias:@stdlib/complex/float64/real}}( out )
-    25.0
-    > var im = {{alias:@stdlib/complex/float64/imag}}( out )
-    15.0
+    <Complex128>[ 25.0, 15.0 ]
 
 
 {{alias}}.assign( alpha, re, im, out, strideOut, offsetOut )

docs/repl.txt

@@ -36,20 +36,11 @@ interface Scale {
 	*
 	* @example
 	* var Complex128 = require( '@stdlib/complex-float64-ctor' );
-	* var real = require( '@stdlib/complex-float64-real' );
-	* var imag = require( '@stdlib/complex-float64-imag' );
 	*
 	* var z = new Complex128( 5.0, 3.0 );
-	* // returns <Complex128>
 	*
 	* var out = scale( 5.0, z );
-	* // returns <Complex128>
-	*
-	* var re = real( out );
-	* // returns 25.0
-	*
-	* var im = imag( out );
-	* // returns 15.0
+	* // returns <Complex128>[ 25.0, 15.0 ]
 	*/
 	( alpha: number, z: Complex128 ): Complex128;
 
@@ -108,20 +99,11 @@ interface Scale {
 *
 * @example
 * var Complex128 = require( '@stdlib/complex-float64-ctor' );
-* var real = require( '@stdlib/complex-float64-real' );
-* var imag = require( '@stdlib/complex-float64-imag' );
 *
 * var z = new Complex128( 5.0, 3.0 );
-* // returns <Complex128>
 *
 * var out = scale( 5.0, z );
-* // returns <Complex128>
-*
-* var re = real( out );
-* // returns 25.0
-*
-* var im = imag( out );
-* // returns 15.0
+* // returns <Complex128>[ 25.0, 15.0 ]
 *
 * @example
 * var Float64Array = require( '@stdlib/array-float64' );

docs/types/index.d.ts

@@ -25,21 +25,12 @@
 *
 * @example
 * var Complex128 = require( '@stdlib/complex-float64-ctor' );
-* var real = require( '@stdlib/complex-float64-real' );
-* var imag = require( '@stdlib/complex-float64-imag' );
 * var scale = require( '@stdlib/complex-float64-base-scale' );
 *
 * var z = new Complex128( 5.0, 3.0 );
-* // returns <Complex128>
 *
-* var out = scale( scalar, z );
-* // returns <Complex128>
-*
-* var re = real( out );
-* // returns 25.0
-*
-* var im = imag( out );
-* // returns 15.0
+* var out = scale( 5.0, z );
+* // returns <Complex128>[ 25.0, 15.0 ]
 */
 
 // MODULES //

lib/index.js

@@ -36,20 +36,11 @@ 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 z = new Complex128( 5.0, 3.0 );
-* // returns <Complex128>
 *
 * var out = scale( 5.0, z );
-* // returns <Complex128>
-*
-* var re = real( out );
-* // returns 25.0
-*
-* var im = imag( out );
-* // returns 15.0
+* // returns <Complex128>[ 25.0, 15.0 ]
 */
 function scale( alpha, z ) {
 	return new Complex128( real( z ) * alpha, imag( z ) * alpha );

lib/main.js

@@ -36,20 +36,11 @@ 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 z = new Complex128( 5.0, 3.0 );
-* // returns <Complex128>
 *
 * var out = scale( 5.0, z );
-* // returns <Complex128>
-*
-* var re = real( out );
-* // returns 25.0
-*
-* var im = imag( out );
-* // returns 15.0
+* // returns <Complex128>[ 25.0, 15.0 ]
 */
 function scale( alpha, z ) {
 	var v = addon( alpha, z );