docs: update descriptions

Signed-off-by: Athan <kgryte@gmail.com>
stdlib-js · Mar 21, 2024 · 0d21a57 · 0d21a57
1 parent c1d20f7
commit 0d21a57
Showing 1 changed file with 12 additions and 20 deletions.
diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapx/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/sapx/docs/repl.txt
@@ -1,7 +1,7 @@
 
 {{alias}}( N, alpha, x, stride )
-    Adds a constant to each element in a single-precision floating-point 
-    strided array.
+    Adds a constant to each element in a single-precision floating-point strided
+    array.
 
     The `N` and stride parameters determine which elements in the strided array
     are accessed at runtime.
@@ -23,34 +23,29 @@
         Input array.
 
     stride: integer
-        Index increment for `x`.
+        Index increment.
 
     Returns
     -------
     x: Float32Array
-        Input array `x`.
+        Input array.
 
     Examples
     --------
     // Standard Usage:
     > var x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ] );
-    > var alpha = 5.0;
-    > {{alias}}( x.length, alpha, x, 1 )
+    > {{alias}}( x.length, 5.0, x, 1 )
     <Float32Array>[ 3.0, 6.0, 8.0, 0.0, 9.0, 4.0, 2.0 ]
 
     // Using `N` and `stride` parameters:
     > x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ] );
-    > alpha = 5.0;
-    > var stride = 2;
-    > {{alias}}( 3, alpha, x, stride )
+    > {{alias}}( 3, 5.0, x, 2 )
     <Float32Array>[ 3.0, 1.0, 8.0, -5.0, 9.0, -1.0, -3.0 ]
 
     // Using view offsets:
     > var x0 = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
     > var x1 = new {{alias:@stdlib/array/float32}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
-    > alpha = 5.0;
-    > stride = 2;
-    > {{alias}}( 3, alpha, x1, stride )
+    > {{alias}}( 3, 5.0, x1, 2 )
     <Float32Array>[ 3.0, 3.0, 1.0, 5.0, -1.0 ]
     > x0
     <Float32Array>[ 1.0, 3.0, 3.0, 1.0, 5.0, -1.0 ]
@@ -76,29 +71,26 @@
         Input array.
 
     stride: integer
-        Index increment for `x`.
+        Index increment.
 
     offset: integer
-        Starting index of `x`.
+        Starting index.
 
     Returns
     -------
     x: Float32Array
-        Input array `x`.
+        Input array.
 
     Examples
     --------
     // Standard Usage:
     > var x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ] );
-    > var alpha = 5.0;
-    > {{alias}}.ndarray( x.length, alpha, x, 1, 0 )
+    > {{alias}}.ndarray( x.length, 5.0, x, 1, 0 )
     <Float32Array>[ 3.0, 6.0, 8.0, 0.0, 9.0, 4.0, 2.0 ]
 
     // Using an index offset:
     > x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
-    > alpha = 5.0;
-    > var stride = 2;
-    > {{alias}}.ndarray( 3, alpha, x, stride, 1 )
+    > {{alias}}.ndarray( 3, 5.0, x, 2, 1 )
     <Float32Array>[ 1.0, 3.0, 3.0, 1.0, 5.0, -1.0 ]
 
     See Also