Skip to content

Commit 26dfea9

Browse files
committed
style: fix line wrapping
--- 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 63a9af5 commit 26dfea9

File tree

1 file changed

+10
-11
lines changed
  • lib/node_modules/@stdlib/stats/base/ndarray/variancech/docs

1 file changed

+10
-11
lines changed

lib/node_modules/@stdlib/stats/base/ndarray/variancech/docs/repl.txt

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

22
{{alias}}( arrays )
3-
Computes the variance of a one-dimensional ndarray using a
4-
one-pass trial mean algorithm.
3+
Computes the variance of a one-dimensional ndarray using a one-pass trial
4+
mean algorithm.
55

66
If provided an empty one-dimensional ndarray, the function returns `NaN`.
77

@@ -16,15 +16,14 @@
1616
ndarray and a zero-dimensional ndarray specifying the degrees of freedom
1717
adjustment. Providing a non-zero degrees of freedom adjustment has the
1818
effect of adjusting the divisor during the calculation of the variance
19-
according to `N-c` where `N` is the number of elements in the
20-
input ndarray and `c` corresponds to the provided degrees of freedom
21-
adjustment. When computing the variance of a population,
22-
setting this parameter to `0` is the standard choice (i.e., the provided
23-
array contains data constituting an entire population). When computing
24-
the corrected sample variance, setting this parameter to `1`
25-
is the standard choice (i.e., the provided array contains data sampled
26-
from a larger population; this is commonly referred to as Bessel's
27-
correction).
19+
according to `N-c` where `N` is the number of elements in the input
20+
ndarray and `c` corresponds to the provided degrees of freedom
21+
adjustment. When computing the variance of a population, setting this
22+
parameter to `0` is the standard choice (i.e., the provided array
23+
contains data constituting an entire population). When computing the
24+
corrected sample variance, setting this parameter to `1` is the standard
25+
choice (i.e., the provided array contains data sampled from a larger
26+
population; this is commonly referred to as Bessel's correction).
2827

2928
Returns
3029
-------

0 commit comments

Comments
 (0)