Skip to content

Commit 0b5a64c

Browse files
committed
docs: update copy and example
--- 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: passed - 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 0abca05 commit 0b5a64c

File tree

2 files changed

+7
-4
lines changed
  • lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/float64

2 files changed

+7
-4
lines changed

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ var results = new Float64Results();
5151

5252
The function supports the following parameters:
5353

54-
- **arg**: an `ArrayBuffer` or a data object (_optional_).
54+
- **arg**: an [`ArrayBuffer`][@stdlib/array/buffer] or a data object (_optional_).
5555
- **byteOffset**: byte offset (_optional_).
5656
- **byteLength**: maximum byte length (_optional_).
5757

@@ -62,7 +62,7 @@ A data object argument is an object having one or more of the following properti
6262
- **alpha**: significance level.
6363
- **pValue**: p-value.
6464
- **statistic**: test statistic.
65-
- **ci**: confidence interval as a `Float64Array`.
65+
- **ci**: confidence interval as a [`Float64Array`][@stdlib/array/float64].
6666
- **nullValue**: mean under the null hypothesis.
6767
- **sd**: standard error of the mean.
6868

@@ -316,6 +316,10 @@ console.log( str );
316316

317317
[@stdlib/array/dataview]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/dataview
318318

319+
[@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64
320+
321+
[@stdlib/array/buffer]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/buffer
322+
319323
</section>
320324

321325
<!-- /.links -->

lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/float64/lib/index.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,13 @@
2424
* @module @stdlib/stats/base/ztest/one-sample/results/float64
2525
*
2626
* @example
27-
* var resolveEnum = require( '@stdlib/stats/base/ztest/alternative-resolve-enum' );
2827
* var Float64Array = require( '@stdlib/array/float64' );
2928
* var Results = require( '@stdlib/stats/base/ztest/one-sample/results/float64' );
3029
*
3130
* var results = new Results();
3231
* // returns <Results>
3332
*
34-
* results.alternative = resolveEnum( 'two-sided' );
33+
* results.alternative = 'two-sided';
3534
* results.alpha = 0.05;
3635
* results.nullValue = 0.0;
3736
* results.pValue = 0.3374;

0 commit comments

Comments
 (0)