Skip to content

Commit 1417068

Browse files
committed
docs: update parameter description
--- 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: 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 1d86748 commit 1417068

File tree

2 files changed

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

2 files changed

+4
-4
lines changed

lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/factory/docs/types/index.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ declare class ResultsStruct<T> {
7272
*
7373
* @param arg - buffer or data object
7474
* @param byteOffset - byte offset
75-
* @param byteLength - byte length
75+
* @param byteLength - maximum byte length
7676
* @returns results
7777
*/
7878
constructor( arg?: ArrayBuffer | Results<T>, byteOffset?: number, byteLength?: number );
@@ -132,7 +132,7 @@ interface ResultsConstructor<T> {
132132
*
133133
* @param arg - buffer or data object
134134
* @param byteOffset - byte offset
135-
* @param byteLength - byte length
135+
* @param byteLength - maximum byte length
136136
* @returns struct
137137
*/
138138
new( arg?: ArrayBuffer | Results<T>, byteOffset?: number, byteLength?: number ): ResultsStruct<T>;
@@ -142,7 +142,7 @@ interface ResultsConstructor<T> {
142142
*
143143
* @param arg - buffer or data object
144144
* @param byteOffset - byte offset
145-
* @param byteLength - byte length
145+
* @param byteLength - maximum byte length
146146
* @returns struct
147147
*/
148148
( arg?: ArrayBuffer | Results<T>, byteOffset?: number, byteLength?: number ): ResultsStruct<T>;

lib/node_modules/@stdlib/stats/base/ztest/one-sample/results/factory/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ function factory( dtype ) {
101101
* @constructor
102102
* @param {(ArrayBuffer|Object)} [arg] - underlying byte buffer or a data object
103103
* @param {NonNegativeInteger} [byteOffset] - byte offset
104-
* @param {NonNegativeInteger} [byteLength] - byte length
104+
* @param {NonNegativeInteger} [byteLength] - maximum byte length
105105
* @throws {TypeError} first argument must be an ArrayBuffer or a data object
106106
* @returns {Results} results object
107107
*/

0 commit comments

Comments
 (0)