Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -256,6 +256,7 @@ A total of 33 issues were closed in this release:
 
 <details>
 
+-   [`b4bc4a9`](https://github.com/stdlib-js/stdlib/commit/b4bc4a97a705a981e343345f4c2b0d5aee7104ff) - **docs:** improve doctests for complex number instances in `array/base/accessor-getter` [(#8644)](https://github.com/stdlib-js/stdlib/pull/8644) _(by Divyanshu)_
 -   [`322eefc`](https://github.com/stdlib-js/stdlib/commit/322eefcff2e0d83f4e302c02bd57cee2a442b8f0) - **docs:** fix interface name in `array/base/one-to` TypeScript declarations _(by Philipp Burckhardt)_
 -   [`f223373`](https://github.com/stdlib-js/stdlib/commit/f223373e1c5b86f2ba763cb92472b03096485604) - **chore:** simplify declarations _(by Athan Reines)_
 -   [`d22a58e`](https://github.com/stdlib-js/stdlib/commit/d22a58eaa5cea695ecb9809f85edea36d1199c74) - **refactor:** simplify declarations _(by Athan Reines)_
@@ -617,14 +618,15 @@ A total of 33 issues were closed in this release:
 
 ### Contributors
 
-A total of 19 people contributed to this release. Thank you to the following contributors:
+A total of 20 people contributed to this release. Thank you to the following contributors:
 
 -   Aayush Khanna
 -   Abhijit Raut
 -   Aditya Sapra
 -   Ahmed Kashkoush
 -   Anshu Kumar
 -   Athan Reines
+-   Divyanshu
 -   Geo Daoyu
 -   Gururaj Gurram
 -   Jay Soni

base/accessor-getter/README.md

@@ -46,20 +46,12 @@ Returns an accessor function for retrieving an element from an array-like object
 
 ```javascript
 var Complex64Array = require( '@stdlib/array/complex64' );
-var realf = require( '@stdlib/complex/float32/real' );
-var imagf = require( '@stdlib/complex/float32/imag' );
 
 var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
 
 var get = accessorGetter( 'complex64' );
 var v = get( arr, 1 );
-// returns <Complex64>
-
-var re = realf( v );
-// returns 3.0
-
-var im = imagf( v );
-// returns 4.0
+// returns <Complex64>[ 3.0, 4.0 ]
 ```
 
 The returned accessor function accepts the following arguments:
@@ -104,14 +96,14 @@ var accessorGetter = require( '@stdlib/array/base/accessor-getter' );
 
 var arr = new Complex128Array( zeroTo( 10 ) );
 var v = accessorGetter( dtype( arr ) )( arr, 2 );
-// returns <Complex128>
+// returns <Complex128>[ 4.0, 5.0 ]
 
 console.log( v.toString() );
 // => '4 + 5i'
 
 arr = new Complex64Array( zeroTo( 10 ) );
 v = accessorGetter( dtype( arr ) )( arr, 4 );
-// returns <Complex64>
+// returns <Complex64>[ 8.0, 9.0 ]
 
 console.log( v.toString() );
 // => '8 + 9i'

base/accessor-getter/docs/repl.txt

@@ -44,11 +44,7 @@
     --------
     > var f = {{alias}}( 'complex64' );
     > var v = f( {{alias:@stdlib/array/complex64}}( [ 1, 2, 3, 4 ] ), 1 )
-    <Complex64>
-    > var r = {{alias:@stdlib/complex/float32/real}}( v )
-    3.0
-    > var i = {{alias:@stdlib/complex/float32/imag}}( v )
-    4.0
+    <Complex64>[ 3.0, 4.0 ]
 
     See Also
     --------

base/accessor-getter/docs/types/index.d.ts

@@ -58,20 +58,12 @@ type GetArrayLike<T> = ( arr: AccessorArrayLike<T>, idx: number ) => T;
 *
 * @example
 * var Complex128Array = require( '@stdlib/array/complex128' );
-* var real = require( '@stdlib/array/real' );
-* var imag = require( '@stdlib/array/imag' );
 *
 * var arr = new Complex128Array( [ 1, 2, 3, 4 ] );
 *
 * var get = getter( 'complex128' );
 * var v = get( arr, 1 );
-* // returns <Complex128>
-*
-* var re = real( v );
-* // returns 3.0
-*
-* var im = imag( v );
-* // returns 4.0
+* // returns <Complex128>[ 3.0, 4.0 ]
 */
 declare function getter( dtype: 'complex128' ): GetComplex128;
 
@@ -83,20 +75,12 @@ declare function getter( dtype: 'complex128' ): GetComplex128;
 *
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
-* var realf = require( '@stdlib/array/realf' );
-* var imagf = require( '@stdlib/array/imagf' );
 *
 * var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
 *
 * var get = getter( 'complex64' );
 * var v = get( arr, 1 );
-* // returns <Complex64>
-*
-* var re = realf( v );
-* // returns 3.0
-*
-* var im = imagf( v );
-* // returns 4.0
+* // returns <Complex64>[ 3.0, 4.0 ]
 */
 declare function getter( dtype: 'complex64' ): GetComplex64;
 

base/accessor-getter/examples/index.js

@@ -26,12 +26,12 @@ var accessorGetter = require( './../lib' );
 
 var arr = new Complex128Array( zeroTo( 10 ) );
 var v = accessorGetter( dtype( arr ) )( arr, 2 );
-// returns <Complex128>
+// returns <Complex128>[ 4.0, 5.0 ]
 
 console.log( '%s', v.toString() );
 
 arr = new Complex64Array( zeroTo( 10 ) );
 v = accessorGetter( dtype( arr ) )( arr, 4 );
-// returns <Complex64>
+// returns <Complex64>[ 8.0, 9.0 ]
 
 console.log( '%s', v.toString() );

base/accessor-getter/lib/index.js

@@ -25,22 +25,14 @@
 *
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
-* var realf = require( '@stdlib/complex/float32/real' );
-* var imagf = require( '@stdlib/complex/float32/imag' );
 * var dtype = require( '@stdlib/array/dtype' );
 * var getter = require( '@stdlib/array/base/accessor-getter' );
 *
 * var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
 *
 * var get = getter( dtype( arr ) );
 * var v = get( arr, 1 );
-* // returns <Complex64>
-*
-* var re = realf( v );
-* // returns 3.0
-*
-* var im = imagf( v );
-* // returns 4.0
+* // returns <Complex64>[ 3.0, 4.0 ]
 */
 
 // MODULES //

base/accessor-getter/lib/main.js

@@ -39,19 +39,11 @@ var GETTERS = {
 *
 * @example
 * var Complex128Array = require( '@stdlib/array/complex128' );
-* var real = require( '@stdlib/complex/float64/real' );
-* var imag = require( '@stdlib/complex/float64/imag' );
 *
 * var arr = new Complex128Array( [ 1, 2, 3, 4 ] );
 *
 * var v = getComplex128( arr, 1 );
-* // returns <Complex128>
-*
-* var re = real( v );
-* // returns 3.0
-*
-* var im = imag( v );
-* // returns 4.0
+* // returns <Complex128>[ 3.0, 4.0 ]
 */
 function getComplex128( arr, idx ) {
 	return arr.get( idx );
@@ -67,19 +59,11 @@ function getComplex128( arr, idx ) {
 *
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
-* var realf = require( '@stdlib/complex/float32/real' );
-* var imagf = require( '@stdlib/complex/float32/imag' );
 *
 * var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
 *
 * var v = getComplex64( arr, 1 );
-* // returns <Complex64>
-*
-* var re = realf( v );
-* // returns 3.0
-*
-* var im = imagf( v );
-* // returns 4.0
+* // returns <Complex64>[ 3.0, 4.0 ]
 */
 function getComplex64( arr, idx ) {
 	return arr.get( idx );
@@ -125,21 +109,13 @@ function getArrayLike( arr, idx ) {
 *
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
-* var realf = require( '@stdlib/complex/float32/real' );
-* var imagf = require( '@stdlib/complex/float32/imag' );
 * var dtype = require( '@stdlib/array/dtype' );
 *
 * var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
 *
 * var get = getter( dtype( arr ) );
 * var v = get( arr, 1 );
-* // returns <Complex64>
-*
-* var re = realf( v );
-* // returns 3.0
-*
-* var im = imagf( v );
-* // returns 4.0
+* // returns <Complex64>[ 3.0, 4.0 ]
 */
 function getter( dtype ) {
 	var f = GETTERS[ dtype ];