Skip to content

Commit 618b2a6

Browse files
committed
docs: update TS declarations and repl documentation
--- 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: na - 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent c54682d commit 618b2a6

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

lib/node_modules/@stdlib/math/base/special/kernel-log1pf/docs/repl.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11

22
{{alias}}( f )
3-
Computes `logf(1+f) - f` for `1+f` in ~[sqrtf(2)/2, sqrtf(2)].
3+
Computes `log(1+f) - f` for `1+f` in `~[sqrt(2)/2, sqrt(2)]` as a
4+
single-precision floating-point number.
45

56
This function provides a common means for computing logarithms in base e.
67
Argument reduction and adding the final term of the polynomial must be done
@@ -20,7 +21,7 @@
2021
--------
2122
> var y = {{alias}}( 1.0 )
2223
~0.1931
23-
> y = {{alias}}( 1.4142135 )
24+
> y = {{alias}}( 1.4142135381698608 )
2425
~0.4672
2526
> y = {{alias}}( NaN )
2627
NaN

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
// TypeScript Version: 4.1
2020

2121
/**
22-
* Computes `logf(1+f) - f` for `1+f` in `~[sqrtf(2)/2, sqrtf(2)]`.
22+
* Computes `log(1+f) - f` for `1+f` in `~[sqrtf(2)/2, sqrtf(2)]` as a single-precision floating-point number.
2323
*
2424
* ## Notes
2525
*

0 commit comments

Comments
 (0)