Skip to content

Commit 776f485

Browse files
committed
docs: correct parameter descriptions
--- 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: passed - 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 678f471 commit 776f485

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,8 +145,8 @@ stdlib_base_modf( 4.0, &integral, &frac );
145145
The function accepts the following arguments:
146146
147147
- **x**: `[in] double` input value.
148-
- **frac**: `[out] double*` destination for the integral part.
149-
- **exp**: `[out] double*` destination for the fractional part.
148+
- **integral**: `[out] float*` destination for the integral part.
149+
- **frac**: `[out] float*` destination for the fractional part.
150150
151151
```c
152152
void stdlib_base_modf( const double x, double *integral, double *frac );

lib/node_modules/@stdlib/math/base/special/modf/src/main.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ static const uint32_t ALL_ONES = 4294967295;
3232
* Decomposes a double-precision floating-point number into integral and fractional parts, each having the same type and sign as the input value, and assigns results to a provided output array.
3333
*
3434
* @param x input value
35-
* @param frac destination to store the normalized fraction
36-
* @param integral destination to store the exponent
35+
* @param integral destination pointer for the integral part
36+
* @param frac destination pointer for the fractional part
3737
*
3838
* @example
3939
* double x = 3.141592653589793;

0 commit comments

Comments
 (0)