Skip to content

Commit 69ad0f3

Browse files
committed
docs: minor clean-up
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 992d491 commit 69ad0f3

File tree

9 files changed

+10
-10
lines changed

9 files changed

+10
-10
lines changed

lib/node_modules/@stdlib/blas/base/cscal/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ int main( void ) {
284284
printf( "x[ %i ] = %f + %fj\n", i, x[ i*2 ], x[ (i*2)+1 ] );
285285
}
286286

287-
// Scale the elements of the array:
287+
// Scale the elements of the array using alternative indexing semantics:
288288
c_cscal_ndarray( N, alpha, (void *)x, -strideX, 3 );
289289

290290
// Print the result:

lib/node_modules/@stdlib/blas/base/cswap/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ int main( void ) {
275275
const int strideX = 1;
276276
const int strideY = -1;
277277

278-
// Copy elements:
278+
// Interchange the vectors:
279279
c_cswap( N, (void *)x, strideX, (void *)y, strideY );
280280

281281
// Print the result:

lib/node_modules/@stdlib/blas/base/dcabs1/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Computes the sum of the [absolute values][absolute-value] of the real and imagin
103103

104104
const stdlib_complex128_t c = stdlib_complex128( 5.0, -3.0 );
105105

106-
double y = c_dcabs1( z );
106+
double y = c_dcabs1( c );
107107
// returns 8.0
108108
```
109109

@@ -148,7 +148,7 @@ int main( void ) {
148148
stdlib_complex128( 0.0/0.0, 0.0/0.0 )
149149
};
150150
151-
float y;
151+
double y;
152152
int i;
153153
for ( i = 0; i < 4; i++ ) {
154154
y = c_dcabs1( x[ i ] );

lib/node_modules/@stdlib/blas/base/ssymv/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ The function has the following parameters:
5252
- **N**: number of elements along each dimension of `A`.
5353
- **α**: scalar constant.
5454
- **A**: input matrix stored in linear memory as a [`Float32Array`][mdn-float32array].
55-
- **lda**: stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
55+
- **LDA**: stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
5656
- **x**: input [`Float32Array`][mdn-float32array].
5757
- **sx**: index increment for `x`.
5858
- **β**: scalar constant.

lib/node_modules/@stdlib/blas/base/transpose-operation-enum2str/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ var s = enum2str( v );
5454
// returns 'transpose'
5555
```
5656

57-
If unable to resolve a operation string, the function returns `null`.
57+
If unable to resolve an operation string, the function returns `null`.
5858

5959
```javascript
6060
var v = enum2str( -999999999 );

lib/node_modules/@stdlib/blas/base/wasm/cscal/docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -532,7 +532,7 @@
532532
> mod.write( zptr, new {{alias:@stdlib/array/float32}}( [ 2.0, 2.0 ] ) );
533533

534534
// Perform computation:
535-
> mod.main( 5, zptr, xptr, 1, 0 );
535+
> mod.ndarray( 5, zptr, xptr, 1, 0 );
536536

537537
// Extract results from module memory:
538538
> var view = {{alias:@stdlib/array/zeros}}( 5, 'complex64' );

lib/node_modules/@stdlib/blas/base/wasm/csrot/docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@
211211

212212

213213
{{alias}}.Module.prototype.view
214-
Read-only property which returns a WebAsssembly memory buffer as a DataView.
214+
Read-only property which returns a WebAssembly memory buffer as a DataView.
215215

216216
Returns
217217
-------

lib/node_modules/@stdlib/blas/base/wasm/dcopy/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ The function has the following parameters:
4949
- **N**: number of indexed elements.
5050
- **x**: input [`Float64Array`][@stdlib/array/float64].
5151
- **strideX**: index increment for `x`.
52-
- **y**: input [`Float64Array`][@stdlib/array/float64].
52+
- **y**: output [`Float64Array`][@stdlib/array/float64].
5353
- **strideY**: index increment for `y`.
5454

5555
The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to copy every other element from `x` into `y` in reverse order,

lib/node_modules/@stdlib/blas/base/wasm/sasum/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ limitations under the License.
3030
var sasum = require( '@stdlib/blas/base/wasm/sasum' );
3131
```
3232

33-
#### sasum.main( N, x, stride )
33+
#### sasum.main( N, x, strideX )
3434

3535
Computes the sum of absolute values.
3636

0 commit comments

Comments
 (0)