Skip to content

Commit 6471b8e

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: 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 24e19f9 commit 6471b8e

File tree

9 files changed

+17
-13
lines changed

9 files changed

+17
-13
lines changed

lib/node_modules/@stdlib/math/base/special/fibonaccif/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ The function accepts the following arguments:
176176
- **n**: `[in] int32_t` input value.
177177

178178
```c
179-
float stdlib_base_fibonacci( const int32_t n );
179+
float stdlib_base_fibonaccif( const int32_t n );
180180
```
181181
182182
</section>

lib/node_modules/@stdlib/math/base/special/invf/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ The function accepts the following arguments:
139139
- **x**: `[in] float` input value.
140140

141141
```c
142-
float stdlib_base_inv( const float x );
142+
float stdlib_base_invf( const float x );
143143
```
144144
145145
</section>

lib/node_modules/@stdlib/math/base/special/kernel-betainc/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ for ( i = 0; i < 100; i++ ) {
126126
x = randu();
127127
a = randu() * 10.0;
128128
b = randu() * 10.0;
129-
kernelBetainc( x, a, b, true, false, out, 1, 0 );
129+
kernelBetainc.assign( x, a, b, true, false, out, 1, 0 );
130130
console.log( 'x: %d, \t a: %d, \t b: %d, \t f(x,a,b): %d, \t f^1(x,a,b): %d', x.toFixed( 4 ), a.toFixed( 4 ), b.toFixed( 4 ), out[ 0 ].toFixed( 4 ), out[ 1 ].toFixed( 4 ) );
131131
}
132132
```

lib/node_modules/@stdlib/math/base/special/kernel-betaincinv/docs/types/index.d.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,16 @@
3333
*
3434
* @example
3535
* var y = kernelBetaincinv( 3.0, 3.0, 0.2, 0.8 )
36-
* // returns[ ~0.327, ~0.673 ]
36+
* // returns [ ~0.327, ~0.673 ]
3737
* @example
3838
* y = kernelBetaincinv( 3.0, 3.0, 0.4, 0.6 )
39-
* // returns[ ~0.446, ~0.554 ]
39+
* // returns [ ~0.446, ~0.554 ]
4040
* @example
4141
* y = kernelBetaincinv( 1.0, 6.0, 0.4, 0.6 )
42-
* // returns[ ~0.082, ~0.918 ]
42+
* // returns [ ~0.082, ~0.918 ]
4343
* @example
4444
* y = kernelBetaincinv( 1.0, 6.0, 0.8, 0.2 )
45-
* // returns[ ~0.235, ~0.765 ]
45+
* // returns [ ~0.235, ~0.765 ]
4646
*/
4747
declare function kernelBetaincinv( a: number, b: number, p: number, q: number ): Array<number>;
4848

lib/node_modules/@stdlib/math/base/special/kernel-cos/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,8 +130,8 @@ logEachMap( 'kernelCos(%0.4f, %0.4f) = %0.4f', x, 0.0, kernelCos );
130130
Computes the [cosine][cosine] of a double-precision floating-point number on `[-π/4, π/4]`.
131131

132132
```c
133-
var v = stdlib_base_kernel_cos( 0.0, 0.0 );
134-
// returns ~0.0
133+
double v = stdlib_base_kernel_cos( 0.0, 0.0 );
134+
// returns ~1.0
135135

136136
v = stdlib_base_kernel_cos( 3.141592653589793/6.0, 0.0 );
137137
// returns ~0.866

lib/node_modules/@stdlib/math/base/special/kernel-sin/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
*
2424
* ## Notes
2525
*
26-
* - For increased accuracy, the number for which the cosine should be evaluated can be supplied as a double-double number (i.e., a non-evaluated sum of two double-precision floating-point numbers `x` and `y`).
26+
* - For increased accuracy, the number for which the sine should be evaluated can be supplied as a double-double number (i.e., a non-evaluated sum of two double-precision floating-point numbers `x` and `y`).
2727
* - The two numbers must satisfy `|y| < 0.5 * ulp( x )`.
2828
*
2929
* @param x - input value (in radians, assumed to be bounded by `~pi/4` in magnitude)

lib/node_modules/@stdlib/math/base/special/ldexp/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,9 @@ x = ldexp( -Infinity, -118 );
6161
// returns -Infinity
6262
```
6363

64-
<section class="usage">
64+
</section>
65+
66+
<!-- /.usage -->
6567

6668
<section class="notes">
6769

lib/node_modules/@stdlib/math/base/special/ldexpf/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,9 @@ x = ldexpf( -Infinity, -118 );
6161
// returns -Infinity
6262
```
6363

64-
<section class="usage">
64+
</section>
65+
66+
<!-- /.usage -->
6567

6668
<section class="notes">
6769

lib/node_modules/@stdlib/math/base/special/log10/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ double stdlib_base_log10( const double x );
175175
#include <stdlib.h>
176176
#include <stdio.h>
177177
178-
int main() {
178+
int main( void ) {
179179
double x;
180180
double v;
181181
int i;

0 commit comments

Comments
 (0)