Auto-generated commit

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-10-03)
+## Unreleased (2024-10-21)
 
 <section class="features">
 
@@ -22,6 +22,7 @@
 
 <details>
 
+-   [`420e21c`](https://github.com/stdlib-js/stdlib/commit/420e21cbeb53062caad324e14b8ea8ca53d51755) - **docs:** fix examples and notes _(by Athan Reines)_
 -   [`5d79f98`](https://github.com/stdlib-js/stdlib/commit/5d79f98fcf24be0adf5ab357964d8afaa6707b86) - **feat:** add `blas/base/drot-wasm` [(#2979)](https://github.com/stdlib-js/stdlib/pull/2979) _(by Aman Bhansali, Athan Reines)_
 
 </details>

CONTRIBUTORS

@@ -28,6 +28,7 @@ EuniceSim142 <[email protected]>
 Frank Kovacs <[email protected]>
 Golden Kumar <[email protected]>
 Gunj Joshi <[email protected]>
+Gururaj Gurram <[email protected]>
 HarshaNP <[email protected]>
 Harshita Kalani <[email protected]>
 Hridyanshu <[email protected]>
@@ -44,6 +45,7 @@ Justin Dennison <[email protected]>
 Kaif Mohd <[email protected]>
 Karthik Prakash <[email protected]>
 Khaldon <[email protected]>
+Kohantika Nath <[email protected]>
 Krishnendu Das <[email protected]>
 Lovelin <[email protected]>
 Manik Sharma <[email protected]>
@@ -67,6 +69,7 @@ Praneki <[email protected]>
 Pratik <[email protected]>
 Priyansh <[email protected]>
 Pushpendra Chandravanshi <[email protected]>
+RISHAV <[email protected]>
 Raunak Kumar Gupta <[email protected]>
 Rejoan Sardar <[email protected]>
 Ricky Reusser <[email protected]>
@@ -94,6 +97,7 @@ Tudor Pagu <[email protected]>
 Tufailahmed Bargir <[email protected]>
 Utkarsh <http://[email protected]>
 Utkarsh Raj <[email protected]>
+UtkershBasnet <[email protected]>
 Vaibhav Patel <[email protected]>
 Varad Gupta <[email protected]>
 Xiaochuan Ye <[email protected]>

docs/repl.txt

@@ -83,7 +83,7 @@
         Number of indexed elements.
 
     x: Float64Array
-        Input array.
+        First input array.
 
     strideX: integer
         Index increment for `x`.
@@ -300,9 +300,9 @@
     Reallocates the underlying WebAssembly memory instance to a specified number
     of bytes.
 
-    WebAssembly memory can only **grow**, not shrink. Hence, if provided a
-    number of bytes which is less than or equal to the size of the current
-    memory, the function does nothing.
+    WebAssembly memory can only *grow*, not shrink. Hence, if provided a number
+    of bytes which is less than or equal to the size of the current memory, the
+    function does nothing.
 
     When non-shared memory is resized, the underlying the `ArrayBuffer` is
     detached, consequently invalidating any associated typed array views. Before

docs/types/index.d.ts

@@ -77,8 +77,9 @@ interface ModuleConstructor {
 	* var viewX = zeros( N, dtype );
 	* var viewY = zeros( N, dtype );
 	* mod.read( xptr, viewX );
-	* mod.read( yptr, viewY );
 	* // viewX => <Float64Array>[ 1.0, 1.0, 1.0, 1.0, 1.0 ]
+	*
+	* mod.read( yptr, viewY );
 	* // viewY => <Float64Array>[ -1.0, -2.0, -3.0, -4.0, -5.0 ]
 	*/
 	new( mem: Memory ): Module; // newable
@@ -134,8 +135,9 @@ interface ModuleConstructor {
 	* var viewX = zeros( N, dtype );
 	* var viewY = zeros( N, dtype );
 	* mod.read( xptr, viewX );
-	* mod.read( yptr, viewY );
 	* // viewX => <Float64Array>[ 1.0, 1.0, 1.0, 1.0, 1.0 ]
+	*
+	* mod.read( yptr, viewY );
 	* // viewY => <Float64Array>[ -1.0, -2.0, -3.0, -4.0, -5.0 ]
 	*/
 	( mem: Memory ): Module; // callable
@@ -202,8 +204,9 @@ interface Module extends ModuleWrapper {
 	* var viewX = zeros( N, dtype );
 	* var viewY = zeros( N, dtype );
 	* mod.read( xptr, viewX );
-	* mod.read( yptr, viewY );
 	* // viewX => <Float64Array>[ 1.0, 1.0, 1.0, 1.0, 1.0 ]
+	*
+	* mod.read( yptr, viewY );
 	* // viewY => <Float64Array>[ -1.0, -2.0, -3.0, -4.0, -5.0 ]
 	*/
 	main( N: number, xptr: number, strideX: number, yptr: number, strideY: number, c: number, s: number ): number;
@@ -267,8 +270,9 @@ interface Module extends ModuleWrapper {
 	* var viewX = zeros( N, dtype );
 	* var viewY = zeros( N, dtype );
 	* mod.read( xptr, viewX );
-	* mod.read( yptr, viewY );
 	* // viewX => <Float64Array>[ 1.0, 1.0, 1.0, 1.0, 1.0 ]
+	*
+	* mod.read( yptr, viewY );
 	* // viewY => <Float64Array>[ -1.0, -2.0, -3.0, -4.0, -5.0 ]
 	*/
 	ndarray( N: number, xptr: number, strideX: number, offsetX: number, yptr: number, strideY: number, offsetY: number, c: number, s: number ): number;
@@ -379,8 +383,9 @@ interface Routine extends ModuleWrapper {
 	* var viewX = zeros( N, dtype );
 	* var viewY = zeros( N, dtype );
 	* mod.read( xptr, viewX );
-	* mod.read( yptr, viewY );
 	* // viewX => <Float64Array>[ 1.0, 1.0, 1.0, 1.0, 1.0 ]
+	*
+	* mod.read( yptr, viewY );
 	* // viewY => <Float64Array>[ -1.0, -2.0, -3.0, -4.0, -5.0 ]
 	*/
 	Module: ModuleConstructor;

lib/routine.js

@@ -180,7 +180,7 @@ setReadOnly( Routine.prototype, 'ndarray', function drot( N, x, strideX, offsetX
 	// Perform computation by calling the corresponding parent method:
 	Module.prototype.ndarray.call( this, N, p0.ptr, p0.stride, p0.offset, p1.ptr, p1.stride, p1.offset, c, s ); // eslint-disable-line max-len
 
-	// If the output arrays data had to be copied to module memory, copy the results to the provided output arrays...
+	// If output array data had to be copied to module memory, copy the results to the provided output arrays...
 	if ( p0.copy ) {
 		readDataView( N, this.view, p0.stride*p0.BYTES_PER_ELEMENT, p0.ptr, x, strideX, offsetX, true ); // eslint-disable-line max-len
 	}