Skip to content

Commit 351de2d

Browse files
committed
docs: fix description
--- 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 c31a503 commit 351de2d

File tree

1 file changed

+3
-3
lines changed
  • lib/node_modules/@stdlib/math/base/special/gammainc

1 file changed

+3
-3
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ logEachMap( 'x: %0.4f, \t s: %0.4f, \t f(x,s): %0.4f', x, s, gammainc );
201201

202202
#### stdlib_base_gammainc( x, a, regularized, upper )
203203

204-
Evaluates the [incomplete gamma function][incomplete-gamma-function] for inputs `x` and `a`. The third and fourth parameters of the function can be used to specify whether instead to evaluate the non-regularized and/or upper incomplete gamma functions, respectively.
204+
Evaluates the [incomplete gamma function][incomplete-gamma-function] for inputs `x` and `a`.
205205

206206
```c
207207
double out = stdlib_base_gammainc( 0.0, 1.0, true, false );
@@ -215,8 +215,8 @@ The function accepts the following arguments:
215215

216216
- **x**: `[in] double` input value.
217217
- **a**: `[in] double` input value.
218-
- **regularized**: `[in] bool` input value.
219-
- **upper**: `[in] bool` input value.
218+
- **regularized**: `[in] bool` boolean indicating whether to evaluate a regularized incomplete gamma function.
219+
- **upper**: `[in] bool` boolean indicating whether to evaluate the upper incomplete gamma function.
220220

221221
```c
222222
double stdlib_base_gammainc( const double x, const double a, const bool regularized, const bool upper );

0 commit comments

Comments
 (0)