Skip to content

Commit 9da87cf

Browse files
committed
docs: improve clarity in standard deviation 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent de0b3c1 commit 9da87cf

File tree

1 file changed

+4
-3
lines changed
  • lib/node_modules/@stdlib/stats/base/stdevpn/docs

1 file changed

+4
-3
lines changed

lib/node_modules/@stdlib/stats/base/stdevpn/docs/repl.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Computes the standard deviation of a strided array using a two-pass
44
algorithm.
55

6-
The `N` and stride parameters determine which elements in the strided array are accessed
7-
at runtime.
6+
The `N` and stride parameters determine which elements in the strided array
7+
are accessed at runtime.
88

99
Indexing is relative to the first index. To introduce an offset, use a typed
1010
array view.
@@ -57,6 +57,7 @@
5757
> {{alias}}( 3, 1, x1, 2 )
5858
~2.0817
5959

60+
6061
{{alias}}.ndarray( N, correction, x, strideX, offsetX )
6162
Computes the standard deviation of a strided array using a two-pass
6263
algorithm and alternative indexing semantics.
@@ -86,7 +87,7 @@
8687
Input array.
8788

8889
strideX: integer
89-
Index increment.
90+
Stride length.
9091

9192
offsetX: integer
9293
Starting index.

0 commit comments

Comments
 (0)