Skip to content

Commit cbf51ef

Browse files
committed
docs: document parameters
--- 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 c761dd8 commit cbf51ef

File tree

1 file changed

+4
-0
lines changed
  • lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/to-json

1 file changed

+4
-0
lines changed

lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/to-json/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,10 @@ var o = res2json( results );
5555
// returns {...}
5656
```
5757

58+
The function supports the following parameters:
59+
60+
- **results**: one-sample Z-test results object.
61+
5862
</section>
5963

6064
<!-- /.usage -->

0 commit comments

Comments
 (0)