Skip to content

Commit a84070b

Browse files
committed
chore: update notes and ensure n is first argument in examples
--- 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: passed - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - 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 fb42068 commit a84070b

File tree

4 files changed

+6
-4
lines changed

4 files changed

+6
-4
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ var opts = {
116116
var x = uniform( 100, -50.0, 50.0, opts );
117117
var n = discreteUniform( 100, 0, 50, opts );
118118

119-
logEachMap( 'x: %0.4f, ψ^(%d)(x): %0.4f', x, n, polygamma );
119+
logEachMap( 'ψ^(%d)(x = %0.4f): %0.4f', n, x, polygamma );
120120
```
121121

122122
</section>

lib/node_modules/@stdlib/math/base/special/polygamma/docs/repl.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55

66
If `n` is not a nonnegative integer, the function returns `NaN`.
77

8-
If `x` is zero or a negative integer, the function returns `NaN`.
8+
If `x` is zero or a negative odd integer, the function returns `+Infinity`.
9+
If `x` is a negative even integer, the function returns `NaN`.
910

1011
If provided `NaN` as either parameter, the function returns `NaN`.
1112

lib/node_modules/@stdlib/math/base/special/polygamma/docs/types/index.d.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@
2424
* ## Notes
2525
*
2626
* - If `n` is not a nonnegative integer, the function returns `NaN`.
27-
* - If `x` is zero or a negative integer, the function returns `NaN`.
27+
* - If `x` is zero or a negative odd integer, the function returns `+Infinity`.
28+
* - If `x` is a negative even integer, the function returns `NaN`.
2829
*
2930
* @param n - order of derivative
3031
* @param x - input value

lib/node_modules/@stdlib/math/base/special/polygamma/examples/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,4 @@ var opts = {
2929
var x = uniform( 100, -50.0, 50.0, opts );
3030
var n = discreteUniform( 100, 0, 50, opts );
3131

32-
logEachMap( 'x: %0.4f, ψ^(%d)(x): %0.4f', x, n, polygamma );
32+
logEachMap( 'ψ^(%d)(x = %0.4f): %0.4f', n, x, polygamma );

0 commit comments

Comments
 (0)