Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -3524,6 +3524,7 @@ A total of 558 issues were closed in this release:
 
 <details>
 
+-   [`975697c`](https://github.com/stdlib-js/stdlib/commit/975697c99f123dbf8ca5943c877dd6d99740af02) - **docs:** update return annotations to use ndarray instance notation for `stats/range` [(#9246)](https://github.com/stdlib-js/stdlib/pull/9246) _(by Samarth Kolarkar)_
 -   [`ea2e468`](https://github.com/stdlib-js/stdlib/commit/ea2e468ba5638502b1b59cf5d946ba065fae9f7e) - **docs:** update examples [(#9239)](https://github.com/stdlib-js/stdlib/pull/9239) _(by stdlib-bot)_
 -   [`d9ba91b`](https://github.com/stdlib-js/stdlib/commit/d9ba91b874e4ca00243e6d51fff6231d4ab801c2) - **docs:** update return annotations to use ndarray instance notation for `stats/nanminabs` [(#9223)](https://github.com/stdlib-js/stdlib/pull/9223) _(by Sachin Pangal)_
 -   [`30ac15d`](https://github.com/stdlib-js/stdlib/commit/30ac15d266224258d0f50599b43506b4745cf5c9) - **docs:** update return annotations to use ndarray instance notation for `stats/nanmin-by` [(#9195)](https://github.com/stdlib-js/stdlib/pull/9195) _(by Sachin Pangal)_
@@ -6458,7 +6459,7 @@ A total of 558 issues were closed in this release:
 
 ### Contributors
 
-A total of 89 people contributed to this release. Thank you to the following contributors:
+A total of 90 people contributed to this release. Thank you to the following contributors:
 
 -   Aadish Jain
 -   Aayush Khanna
@@ -6534,6 +6535,7 @@ A total of 89 people contributed to this release. Thank you to the following con
 -   SAUJANYA MAGARDE
 -   Sachin Pangal
 -   Sagar Ratna Chaudhary
+-   Samarth Kolarkar
 -   Saurabh Singh
 -   Shabareesh Shetty
 -   Shivansh

range/README.md

@@ -48,10 +48,7 @@ var array = require( '@stdlib/ndarray/array' );
 var x = array( [ -1.0, 2.0, -3.0 ] );
 
 var y = range( x );
-// returns <ndarray>
-
-var v = y.get();
-// returns 5.0
+// returns <ndarray>[ 5.0 ]
 ```
 
 The function has the following parameters:
@@ -68,81 +65,58 @@ The function accepts the following options:
 By default, the function performs a reduction over all elements in a provided input [ndarray][@stdlib/ndarray/ctor]. To perform a reduction over specific dimensions, provide a `dims` option.
 
 ```javascript
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 var array = require( '@stdlib/ndarray/array' );
 
 var x = array( [ -1.0, 2.0, -3.0, 4.0 ], {
     'shape': [ 2, 2 ],
     'order': 'row-major'
 });
-var v = ndarray2array( x );
-// returns [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ]
+// returns <ndarray>[ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ]
 
 var y = range( x, {
     'dims': [ 0 ]
 });
-// returns <ndarray>
-
-v = ndarray2array( y );
-// returns [ 2.0, 2.0 ]
+// returns <ndarray>[ 2.0, 2.0 ]
 
 y = range( x, {
     'dims': [ 1 ]
 });
-// returns <ndarray>
-
-v = ndarray2array( y );
-// returns [ 3.0, 7.0 ]
+// returns <ndarray>[ 3.0, 7.0 ]
 
 y = range( x, {
     'dims': [ 0, 1 ]
 });
-// returns <ndarray>
-
-v = y.get();
-// returns 7.0
+// returns <ndarray>[ 7.0 ]
 ```
 
 By default, the function excludes reduced dimensions from the output [ndarray][@stdlib/ndarray/ctor]. To include the reduced dimensions as singleton dimensions, set the `keepdims` option to `true`.
 
 ```javascript
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 var array = require( '@stdlib/ndarray/array' );
 
 var x = array( [ -1.0, 2.0, -3.0, 4.0 ], {
     'shape': [ 2, 2 ],
     'order': 'row-major'
 });
-
-var v = ndarray2array( x );
-// returns [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ]
+// returns <ndarray>[ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ]
 
 var y = range( x, {
     'dims': [ 0 ],
     'keepdims': true
 });
-// returns <ndarray>
-
-v = ndarray2array( y );
-// returns [ [ 2.0, 2.0 ] ]
+// returns <ndarray>[ [ 2.0, 2.0 ] ]
 
 y = range( x, {
     'dims': [ 1 ],
     'keepdims': true
 });
-// returns <ndarray>
-
-v = ndarray2array( y );
-// returns [ [ 3.0 ], [ 7.0 ] ]
+// returns <ndarray>[ [ 3.0 ], [ 7.0 ] ]
 
 y = range( x, {
     'dims': [ 0, 1 ],
     'keepdims': true
 });
-// returns <ndarray>
-
-v = ndarray2array( y );
-// returns [ [ 7.0 ] ]
+// returns <ndarray>[ [ 7.0 ] ]
 ```
 
 By default, the function returns an [ndarray][@stdlib/ndarray/ctor] having a [data type][@stdlib/ndarray/dtypes] determined by the function's output data type [policy][@stdlib/ndarray/output-dtype-policies]. To override the default behavior, set the `dtype` option.
@@ -176,10 +150,7 @@ var x = array( [ -1.0, 2.0, -3.0 ] );
 var y = zeros( [] );
 
 var out = range.assign( x, y );
-// returns <ndarray>
-
-var v = out.get();
-// returns 5.0
+// returns <ndarray>[ 5.0 ]
 
 var bool = ( out === y );
 // returns true

range/docs/repl.txt

@@ -30,9 +30,8 @@
     Examples
     --------
     > var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] );
-    > var y = {{alias}}( x );
-    > var v = y.get()
-    6.0
+    > var y = {{alias}}( x )
+    <ndarray>[ 6.0 ]
 
 
 {{alias}}.assign( x, out[, options] )
@@ -65,11 +64,9 @@
     > var x = {{alias:@stdlib/ndarray/array}}( [ -1.0, 2.0, -3.0, -4.0 ] );
     > var out = {{alias:@stdlib/ndarray/zeros}}( [] );
     > var y = {{alias}}.assign( x, out )
-    <ndarray>
+    <ndarray>[ 6.0 ]
     > var bool = ( out === y )
     true
-    > var v = out.get()
-    6.0
 
     See Also
     --------

range/docs/types/index.d.ts

@@ -75,10 +75,7 @@ interface Unary {
 	* var x = array( [ -1.0, 2.0, -3.0 ] );
 	*
 	* var y = range( x );
-	* // returns <ndarray>
-	*
-	* var v = y.get();
-	* // returns 5.0
+	* // returns <ndarray>[ 5.0 ]
 	*/
 	<T = unknown, U = unknown>( x: InputArray<T>, options?: Options ): OutputArray<U>; // NOTE: we lose type specificity here, but retaining specificity would likely be difficult and/or tedious to completely enumerate, as the output ndarray data type is dependent on how `x` interacts with output data type policy and whether that policy has been overridden by `options.dtype`.
 
@@ -98,10 +95,7 @@ interface Unary {
 	* var y = zeros( [] );
 	*
 	* var out = range.assign( x, y );
-	* // returns <ndarray>
-	*
-	* var v = out.get();
-	* // returns 5.0
+	* // returns <ndarray>[ 5.0 ]
 	*
 	* var bool = ( out === y );
 	* // returns true
@@ -122,10 +116,7 @@ interface Unary {
 * var x = array( [ -1.0, 2.0, -3.0 ] );
 *
 * var y = range( x );
-* // returns <ndarray>
-*
-* var v = y.get();
-* // returns 5.0
+* // returns <ndarray>[ 5.0 ]
 *
 * @example
 * var array = require( '@stdlib/ndarray/array' );
@@ -135,10 +126,7 @@ interface Unary {
 * var y = zeros( [] );
 *
 * var out = range.assign( x, y );
-* // returns <ndarray>
-*
-* var v = out.get();
-* // returns 5.0
+* // returns <ndarray>[ 5.0 ]
 *
 * var bool = ( out === y );
 * // returns true

range/lib/index.js

@@ -45,10 +45,7 @@
 *
 * // Perform reduction:
 * var out = range( x );
-* // returns <ndarray>
-*
-* var v = out.get();
-* // returns 9.0
+* // returns <ndarray>[ 9.0 ]
 */
 
 // MODULES //

range/lib/main.js

@@ -88,10 +88,7 @@ var table = {
 *
 * // Perform reduction:
 * var out = range( x );
-* // returns <ndarray>
-*
-* var v = out.get();
-* // returns 9.0
+* // returns <ndarray>[ 9.0 ]
 */
 var range = factory( table, [ idtypes ], odtypes, policies );