Skip to content

Commit 46ff8ea

Browse files
PlaneshifterPlaneshifter
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: na - 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 721033e commit 46ff8ea

File tree

11 files changed

+13
-13
lines changed

11 files changed

+13
-13
lines changed

‎lib/node_modules/@stdlib/blas/ext/base/sdsapxsumpw/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ The function has the following parameters:
5454
- **N**: number of indexed elements.
5555
- **alpha**: scalar constant.
5656
- **x**: input [`Float32Array`][@stdlib/array/float32].
57-
- **stride**: stride length.
57+
- **strideX**: stride length.
5858

5959
The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the sum of every other element:
6060

‎lib/node_modules/@stdlib/blas/ext/base/snansumkbn/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ The function has the following parameters:
5353

5454
- **N**: number of indexed elements.
5555
- **x**: input [`Float32Array`][@stdlib/array/float32].
56-
- **stride**: stride length.
56+
- **strideX**: stride length.
5757

5858
The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the sum of every other element:
5959

‎lib/node_modules/@stdlib/buffer/from-string/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ The following `encodings` are supported:
6262
- `hex`
6363
- `binary`
6464
- `ascii`
65-
- `ucs2`
65+
- `ucs2` (`ucs-2`)
6666
- `base64`
6767

6868
</section>

‎lib/node_modules/@stdlib/complex/float32/base/mul/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ var mul = require( '@stdlib/complex/float32/base/mul' );
3838

3939
#### mul( z1, z2 )
4040

41-
Multiples two single-precision complex floating-point numbers.
41+
Multiplies two single-precision complex floating-point numbers.
4242

4343
```javascript
4444
var Complex64 = require( '@stdlib/complex/float32/ctor' );

‎lib/node_modules/@stdlib/complex/float64/base/identity/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ stdlib_complex128_t stdlib_base_complex128_identity( const stdlib_complex128_t z
170170
#include "stdlib/complex/float64/reim.h"
171171
#include <stdio.h>
172172
173-
int main() {
173+
int main( void ) {
174174
const stdlib_complex128_t x[] = {
175175
stdlib_complex128( 3.14, 1.5 ),
176176
stdlib_complex128( -3.14, -1.5 ),

‎lib/node_modules/@stdlib/complex/float64/base/mul-add/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -201,8 +201,8 @@ double im = stdlib_complex128_imag( out );
201201
The function accepts the following arguments:
202202

203203
- **alpha**: `[in] stdlib_complex128_t` input value.
204-
- **z1**: `[in] stdlib_complex128_t` input value.
205-
- **z2**: `[in] stdlib_complex128_t` input value.
204+
- **x**: `[in] stdlib_complex128_t` input value.
205+
- **y**: `[in] stdlib_complex128_t` input value.
206206

207207
```c
208208
stdlib_complex128_t stdlib_base_complex128_muladd( const stdlib_complex128_t alpha, const stdlib_complex128_t x, const stdlib_complex128_t y );

‎lib/node_modules/@stdlib/constants/float16/max/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var FLOAT16_MAX = require( '@stdlib/constants/float16/max' );
3232

3333
#### FLOAT16_MAX
3434

35-
Maximum [single-precision floating-point number][half-precision-floating-point-format].
35+
Maximum [half-precision floating-point number][half-precision-floating-point-format].
3636

3737
```javascript
3838
var bool = (FLOAT16_MAX === 65504.0 );

‎lib/node_modules/@stdlib/constants/float32/max-ln/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ console.log( FLOAT32_MAX_LN );
8888
#include "stdlib/constants/float32/max_ln.h"
8989
```
9090

91-
#### STDLIB_CONSTANT_FLOAT64_MAX_LN
91+
#### STDLIB_CONSTANT_FLOAT32_MAX_LN
9292

9393
Macro for the [natural logarithm][natural-logarithm] of the maximum [single-precision floating-point number][ieee754].
9494

‎lib/node_modules/@stdlib/constants/float32/num-significand-bits/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ console.log( FLOAT32_NUM_SIGNIFICAND_BITS );
9494

9595
#### STDLIB_CONSTANT_FLOAT32_NUM_SIGNIFICAND_BITS
9696

97-
Number of significand bits for a [single-precision floating-point number][ieee754].
97+
Macro for the number of significand bits for a [single-precision floating-point number][ieee754].
9898

9999
</section>
100100

‎lib/node_modules/@stdlib/constants/float32/sqrt-half/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ console.log( FLOAT32_SQRT_HALF );
8888
#include "stdlib/constants/float32/sqrt_half.h"
8989
```
9090

91-
#### STDLIB_CONSTANT_FLOAT64_SQRT_HALF
91+
#### STDLIB_CONSTANT_FLOAT32_SQRT_HALF
9292

9393
Macro for the [square root][@stdlib/math/base/special/sqrtf] of `1/2` as a single-precision floating-point number.
9494

0 commit comments

Comments
 (0)