Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -256,6 +256,7 @@ A total of 33 issues were closed in this release:
 
 <details>
 
+-   [`3c1ebd1`](https://github.com/stdlib-js/stdlib/commit/3c1ebd167342711cdb0ed712c9591a8033aa8497) - **docs:** improve doctests for complex number instances in `array/base/accessor-setter` [(#8645)](https://github.com/stdlib-js/stdlib/pull/8645) _(by Divyanshu)_
 -   [`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)_

base/accessor-setter/README.md

@@ -47,22 +47,14 @@ Returns an accessor function for setting an element in an array-like object supp
 ```javascript
 var Complex64Array = require( '@stdlib/array/complex64' );
 var Complex64 = require( '@stdlib/complex/float32/ctor' );
-var realf = require( '@stdlib/complex/float32/real' );
-var imagf = require( '@stdlib/complex/float32/imag' );
 
 var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
 
 var set = accessorSetter( 'complex64' );
 set( arr, 1, new Complex64( 10.0, 11.0 ) );
 
 var v = arr.get( 1 );
-// returns <Complex64>
-
-var re = realf( v );
-// returns 10.0
-
-var im = imagf( v );
-// returns 11.0
+// returns <Complex64>[ 10.0, 11.0 ]
 ```
 
 The returned accessor function accepts the following arguments:
@@ -113,7 +105,7 @@ var arr = new Complex128Array( zeroTo( 10 ) );
 accessorSetter( dtype( arr ) )( arr, 2, new Complex128( 100.0, 101.0 ) );
 
 var v = arr.get( 2 );
-// returns <Complex128>
+// returns <Complex128>[ 100.0, 101.0 ]
 
 console.log( '%s', v.toString() );
 // => '100 + 101i'
@@ -122,7 +114,7 @@ arr = new Complex64Array( zeroTo( 10 ) );
 accessorSetter( dtype( arr ) )( arr, 4, new Complex64( 102.0, 103.0 ) );
 
 v = arr.get( 4 );
-// returns <Complex64>
+// returns <Complex64>[ 102.0, 103.0 ]
 
 console.log( '%s', v.toString() );
 // => '102 + 103i'

base/accessor-setter/docs/repl.txt

@@ -49,11 +49,7 @@
     > var x = {{alias:@stdlib/array/complex64}}( [ 1, 2, 3, 4 ] );
     > f( x, 1, new {{alias:@stdlib/complex/float32/ctor}}( 10.0, 11.0 ) );
     > var v = x.get( 1 )
-    <Complex64>
-    > var r = {{alias:@stdlib/complex/float32/real}}( v )
-    10.0
-    > var i = {{alias:@stdlib/complex/float32/imag}}( v )
-    11.0
+    <Complex64>[ 10.0, 11.0]
 
     See Also
     --------

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

@@ -59,22 +59,14 @@ type SetArrayLike<T> = ( arr: AccessorArrayLike<T>, idx: number, value: T ) => v
 * @example
 * var Complex128Array = require( '@stdlib/array/complex128' );
 * var Complex128 = require( '@stdlib/complex/float64/ctor' );
-* var real = require( '@stdlib/array/real' );
-* var imag = require( '@stdlib/array/imag' );
 *
 * var arr = new Complex128Array( [ 1, 2, 3, 4 ] );
 *
 * var set = setter( 'complex128' );
 * set( arr, 1, new Complex128( 10.0, 11.0 ) );
 *
 * var v = arr.get( 1 );
-* // returns <Complex128>
-*
-* var re = real( v );
-* // returns 10.0
-*
-* var im = imag( v );
-* // returns 11.0
+* // returns <Complex128>[ 10.0, 11.0 ]
 */
 declare function setter( dtype: 'complex128' ): SetComplex128;
 
@@ -87,22 +79,14 @@ declare function setter( dtype: 'complex128' ): SetComplex128;
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
 * var Complex64 = require( '@stdlib/complex/float32/ctor' );
-* var realf = require( '@stdlib/array/realf' );
-* var imagf = require( '@stdlib/array/imagf' );
 *
 * var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
 *
 * var set = setter( 'complex64' );
 * set( arr, 1, new Complex64( 10.0, 11.0 ) );
 *
 * var v = arr.get( 1 );
-* // returns <Complex64>
-*
-* var re = realf( v );
-* // returns 3.0
-*
-* var im = imagf( v );
-* // returns 4.0
+* // returns <Complex64>[ 10.0, 11.0 ]
 */
 declare function setter( dtype: 'complex64' ): SetComplex64;
 
@@ -130,7 +114,7 @@ declare function setter( dtype: 'complex64' ): SetComplex64;
 * set( arr, 2, 10 );
 *
 * var v = arr.get( 2 );
-* // returns 3
+* // returns 10
 */
 declare function setter<T = unknown>( dtype: string ): SetArrayLike<T>;
 

base/accessor-setter/examples/index.js

@@ -30,7 +30,7 @@ var arr = new Complex128Array( zeroTo( 10 ) );
 accessorSetter( dtype( arr ) )( arr, 2, new Complex128( 100.0, 101.0 ) );
 
 var v = arr.get( 2 );
-// returns <Complex128>
+// returns <Complex128>[ 100.0, 101.0 ]
 
 console.log( '%s', v.toString() );
 // => '100 + 101i'
@@ -39,7 +39,7 @@ arr = new Complex64Array( zeroTo( 10 ) );
 accessorSetter( dtype( arr ) )( arr, 4, new Complex64( 102.0, 103.0 ) );
 
 v = arr.get( 4 );
-// returns <Complex64>
+// returns <Complex64>[ 102.0, 103.0 ]
 
 console.log( '%s', v.toString() );
 // => '102 + 103i'

base/accessor-setter/lib/index.js

@@ -26,8 +26,6 @@
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
 * var Complex64 = require( '@stdlib/complex/float32/ctor' );
-* var realf = require( '@stdlib/complex/float32/real' );
-* var imagf = require( '@stdlib/complex/float32/imag' );
 * var dtype = require( '@stdlib/array/dtype' );
 * var setter = require( '@stdlib/array/base/accessor-setter' );
 *
@@ -37,13 +35,7 @@
 * set( arr, 1, new Complex64( 10.0, 11.0 ) );
 *
 * var v = arr.get( 1 );
-* // returns <Complex64>
-*
-* var re = realf( v );
-* // returns 10.0
-*
-* var im = imagf( v );
-* // returns 11.0
+* // returns <Complex64>[ 10.0, 11.0 ]
 */
 
 // MODULES //

base/accessor-setter/lib/main.js

@@ -40,20 +40,12 @@ var SETTERS = {
 * @example
 * var Complex128Array = require( '@stdlib/array/complex128' );
 * var Complex128 = require( '@stdlib/complex/float64/ctor' );
-* var real = require( '@stdlib/complex/float64/real' );
-* var imag = require( '@stdlib/complex/float64/imag' );
 *
 * var arr = new Complex128Array( [ 1, 2, 3, 4 ] );
 *
 * setComplex128( arr, 1, new Complex128( 10.0, 11.0 ) );
 * var v = arr.get( 1 );
-* // returns <Complex128>
-*
-* var re = real( v );
-* // returns 10.0
-*
-* var im = imag( v );
-* // returns 11.0
+* // returns <Complex128>[ 10.0, 11.0 ]
 */
 function setComplex128( arr, idx, value ) {
 	arr.set( value, idx );
@@ -70,20 +62,12 @@ function setComplex128( arr, idx, value ) {
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
 * var Complex64 = require( '@stdlib/complex/float32/ctor' );
-* var realf = require( '@stdlib/complex/float32/real' );
-* var imagf = require( '@stdlib/complex/float32/imag' );
 *
 * var arr = new Complex64Array( [ 1, 2, 3, 4 ] );
 *
 * setComplex64( arr, 1, new Complex64( 10.0, 11.0 ) );
 * var v = arr.get( 1 );
-* // returns <Complex64>
-*
-* var re = realf( v );
-* // returns 10.0
-*
-* var im = imagf( v );
-* // returns 11.0
+* // returns <Complex64>[ 10.0, 11.0 ]
 */
 function setComplex64( arr, idx, value ) {
 	arr.set( value, idx );
@@ -132,8 +116,6 @@ function setArrayLike( arr, idx, value ) {
 * @example
 * var Complex64Array = require( '@stdlib/array/complex64' );
 * var Complex64 = require( '@stdlib/complex/float32/ctor' );
-* 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 ] );
@@ -142,13 +124,7 @@ function setArrayLike( arr, idx, value ) {
 * set( arr, 1, new Complex64( 10.0, 11.0 ) );
 *
 * var v = arr.get( 1 );
-* // returns <Complex64>
-*
-* var re = realf( v );
-* // returns 10.0
-*
-* var im = imagf( v );
-* // returns 11.0
+* // returns <Complex64>[ 10.0, 11.0 ]
 */
 function setter( dtype ) {
 	var f = SETTERS[ dtype ];