Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-06-04)
+## Unreleased (2025-06-09)
 
 <section class="features">
 
@@ -22,6 +22,7 @@
 
 <details>
 
+-   [`93d2533`](https://github.com/stdlib-js/stdlib/commit/93d2533ff20f6ac32d1b1c35d04679a33476c34c) - **docs:** update examples for `complex/float32/base/sub` [(#7293)](https://github.com/stdlib-js/stdlib/pull/7293) _(by Shabareesh Shetty)_
 -   [`1b155f1`](https://github.com/stdlib-js/stdlib/commit/1b155f118f396a5e2ad21ab2ca50247684109062) - **chore:** change naming and examples for `complex/float32/base/sub` [(#7168)](https://github.com/stdlib-js/stdlib/pull/7168) _(by Shabareesh Shetty)_
 -   [`3a62008`](https://github.com/stdlib-js/stdlib/commit/3a620083a7978286cc05db9231ecbee4d0478e1a) - **feat:** add `complex/float32/base/sub` _(by Gururaj Gurram)_
 

CONTRIBUTORS

@@ -22,6 +22,7 @@ AlyAbdelmoneim <148393799+AlyAbdelmoneim@users.noreply.github.com>
 Aman Bhansali <bhansali.1@iitj.ac.in>
 AmanBhadkariya <140033975+AmanBhadkariya@users.noreply.github.com>
 Amit Jimiwal <amitjimiwal45@gmail.com>
+Annamalai Prabu <apfossdev@gmail.com>
 Anshu Kumar <132515490+anxhukumar@users.noreply.github.com>
 Anshu Kumar <contact.anshukumar@protonmail.com>
 Anudeep Sanapala <anudeep0306@gmail.com>
@@ -38,6 +39,7 @@ Daniel Killenberger <daniel.killenberger@gmail.com>
 Daniel Yu <40680511+Daniel777y@users.noreply.github.com>
 Debashis Maharana <debashismaharana7854@gmail.com>
 Deep Trivedi <128926685+thedeeppp@users.noreply.github.com>
+Deepak Singh <78257493+Deepak91168@users.noreply.github.com>
 Desh Deepak Kant <118960904+DeshDeepakKant@users.noreply.github.com>
 Dev Goel <135586571+corsairier@users.noreply.github.com>
 Dhanyabad behera <110620935+dhanyabad11@users.noreply.github.com>
@@ -53,6 +55,7 @@ Frank Kovacs <fran70kk@gmail.com>
 GK Bishnoi <gkishan1kyt@gmail.com>
 GURU PRASAD SHARMA <168292003+GURUPRASADSHARMA@users.noreply.github.com>
 Gaurav <gaurav70380@gmail.com>
+Gautam Kaushik <162317291+Kaushikgtm@users.noreply.github.com>
 Gautam sharma <gautamkrishnasharma1@gmail.com>
 Girish Garg <garggirish2020@gmail.com>
 Golden Kumar <103646877+AuenKr@users.noreply.github.com>
@@ -118,6 +121,7 @@ Ognjen Jevremović <ognjenjevremovic@users.noreply.github.com>
 Oneday12323 <107678750+Oneday12323@users.noreply.github.com>
 Ori Miles <97595296+orimiles5@users.noreply.github.com>
 Philipp Burckhardt <pburckhardt@outlook.com>
+Pierre Forstmann <15964998+pierreforstmann@users.noreply.github.com>
 Prajjwal Bajpai <142303989+prajjwalbajpai@users.noreply.github.com>
 Prajwal Kulkarni <prajwalkulkarni76@gmail.com>
 Pranav Goswami <pranavchiku11@gmail.com>

README.md

@@ -75,20 +75,12 @@ Subtracts two single-precision complex floating-point numbers.
 
 ```javascript
 var Complex64 = require( '@stdlib/complex-float32-ctor' );
-var realf = require( '@stdlib/complex-float32-real' );
-var imagf = require( '@stdlib/complex-float32-imag' );
 
 var z1 = new Complex64( 5.0, 3.0 );
 var z2 = new Complex64( -2.0, 1.0 );
 
 var v = csubf( z1, z2 );
-// returns <Complex64>
-
-var re = realf( v );
-// returns 7.0
-
-var im = imagf( v );
-// returns 2.0
+// returns <Complex64>[ 7.0, 2.0 ]
 ```
 
 </section>

dist/index.js.map

@@ -31,23 +31,12 @@ import { Complex64 } from '@stdlib/types/complex';
 *
 * @example
 * var Complex64 = require( '@stdlib/complex-float32-ctor' );
-* var realf = require( '@stdlib/complex-float32-real' );
-* var imagf = require( '@stdlib/complex-float32-imag' );
 *
 * var z1 = new Complex64( 5.0, 3.0 );
-* // returns <Complex64>
-*
 * var z2 = new Complex64( -2.0, 1.0 );
-* // returns <Complex64>
 *
 * var out = csubf( z1, z2 );
-* // returns <Complex64>
-*
-* var re = realf( out );
-* // returns 7.0
-*
-* var im = imagf( out );
-* // returns 2.0
+* // returns <Complex64>[ 7.0, 2.0 ]
 */
 declare function csubf( z1: Complex64, z2: Complex64 ): Complex64;
 

docs/types/index.d.ts

@@ -25,24 +25,13 @@
 *
 * @example
 * var Complex64 = require( '@stdlib/complex-float32-ctor' );
-* var realf = require( '@stdlib/complex-float32-real' );
-* var imagf = require( '@stdlib/complex-float32-imag' );
 * var csubf = require( '@stdlib/complex-float32-base-sub' );
 *
 * var z1 = new Complex64( 5.0, 3.0 );
-* // returns <Complex64>
-*
 * var z2 = new Complex64( -2.0, 1.0 );
-* // returns <Complex64>
 *
 * var out = csubf( z1, z2 );
-* // returns <Complex64>
-*
-* var re = realf( out );
-* // returns 7.0
-*
-* var im = imagf( out );
-* // returns 2.0
+* // returns <Complex64>[ 7.0, 2.0 ]
 */
 
 // MODULES //

lib/index.js

@@ -37,23 +37,12 @@ var imagf = require( '@stdlib/complex-float32-imag' );
 *
 * @example
 * var Complex64 = require( '@stdlib/complex-float32-ctor' );
-* var realf = require( '@stdlib/complex-float32-real' );
-* var imagf = require( '@stdlib/complex-float32-imag' );
 *
 * var z1 = new Complex64( 5.0, 3.0 );
-* // returns <Complex64>
-*
 * var z2 = new Complex64( -2.0, 1.0 );
-* // returns <Complex64>
 *
 * var out = csubf( z1, z2 );
-* // returns <Complex64>
-*
-* var re = realf( out );
-* // returns 7.0
-*
-* var im = imagf( out );
-* // returns 2.0
+* // returns <Complex64>[ 7.0, 2.0 ]
 */
 function csubf( z1, z2 ) {
 	var re = f32( realf( z1 ) - realf( z2 ) );

lib/main.js

@@ -36,23 +36,12 @@ var addon = require( './../src/addon.node' );
 *
 * @example
 * var Complex64 = require( '@stdlib/complex-float32-ctor' );
-* var realf = require( '@stdlib/complex-float32-real' );
-* var imagf = require( '@stdlib/complex-float32-imag' );
 *
 * var z1 = new Complex64( 5.0, 3.0 );
-* // returns <Complex64>
-*
 * var z2 = new Complex64( -2.0, 1.0 );
-* // returns <Complex64>
 *
 * var out = csubf( z1, z2 );
-* // returns <Complex64>
-*
-* var re = realf( out );
-* // returns 7.0
-*
-* var im = imagf( out );
-* // returns 2.0
+* // returns <Complex64>[ 7.0, 2.0 ]
 */
 function csubf( z1, z2 ) {
 	var v = addon( z1, z2 );