Skip to content

Commit aa8b15b

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

File tree

13 files changed

+16
-16
lines changed

13 files changed

+16
-16
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Y_1(x) = \frac{1}{\pi} \int_0^\pi \sin(x \sin\theta - \theta) \, d\theta -\frac{
4141

4242
</section>
4343

44-
<!-- ./intro -->
44+
<!-- /.intro -->
4545

4646
<section class="usage">
4747

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ limitations under the License.
3434
var csc = require( '@stdlib/math/base/special/csc' );
3535
```
3636

37-
## csc( x )
37+
#### csc( x )
3838

3939
Evaluates the [cosecant][trigonometric-functions] of `x` (in radians).
4040

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ limitations under the License.
3434
var cscf = require( '@stdlib/math/base/special/cscf' );
3535
```
3636

37-
## cscf( x )
37+
#### cscf( x )
3838

3939
Evaluates the [cosecant][trigonometric-functions] of a single-precision floating-point number (in radians).
4040

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ out = stdlib_base_ellipe( -1.0 );
154154

155155
The function accepts the following arguments:
156156

157-
- **x**: `[in] double` input value.
157+
- **m**: `[in] double` input value.
158158

159159
```c
160160
double stdlib_base_ellipe( const double m );

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

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

196196
```c
197-
double stdlib_base_factorial( const double n );
197+
double stdlib_base_factorial( const double x );
198198
```
199199
200200
</section>

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

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

211211
```c
212-
double stdlib_base_factorialln( const double n );
212+
double stdlib_base_factorialln( const double x );
213213
```
214214
215215
</section>

lib/node_modules/@stdlib/math/base/special/fast/abs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ logEachMap( 'abs(%d) = %d', x, abs );
144144
Computes the absolute value of a double-precision floating-point number.
145145

146146
```c
147-
double y = stdlib_base_fats_abs( -5.0 );
147+
double y = stdlib_base_fast_abs( -5.0 );
148148
// returns 5.0
149149
```
150150

lib/node_modules/@stdlib/math/base/special/fast/alpha-max-plus-beta-min/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ int main( void ) {
200200
201201
</section>
202202
203-
<!-- ./examples -->
203+
<!-- /.examples -->
204204
205205
</section>
206206

lib/node_modules/@stdlib/math/base/special/fast/max/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ Returns the maximum value.
146146
double out = stdlib_base_fast_max( 4.2, 3.14 );
147147
// returns 4.2
148148
149-
out = stdlib_base_max_fast( 0.0, -0.0 );
149+
out = stdlib_base_fast_max( 0.0, -0.0 );
150150
// returns 0.0
151151
```
152152

@@ -165,15 +165,15 @@ double stdlib_base_fast_max( const double x, const double y );
165165
166166
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
167167
168-
<section class="notes">
168+
<section class="notes">
169169
170170
</section>
171171
172172
<!-- /.notes -->
173173
174174
<!-- C API usage examples. -->
175175
176-
<section class="examples">
176+
<section class="examples">
177177
178178
### Examples
179179

lib/node_modules/@stdlib/math/base/special/fast/pow-int/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ out = stdlib_base_fast_pow( 3.14, 0 );
179179
The function accepts the following arguments:
180180

181181
- **x**: `[in] double` base.
182-
- **y**: `[in] double` exponent.
182+
- **y**: `[in] int32_t` exponent.
183183

184184
```c
185185
double stdlib_base_fast_pow( const double x, const int32_t y );

0 commit comments

Comments
 (0)