Skip to content

Commit 1d86748

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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 4d872c8 commit 1d86748

File tree

1 file changed

+1
-1
lines changed
  • lib/node_modules/@stdlib/dstructs/struct/lib

1 file changed

+1
-1
lines changed

lib/node_modules/@stdlib/dstructs/struct/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ function factory( fields ) {
153153
* @private
154154
* @param {(Object|ArrayBuffer)} [arg] - array buffer or data object
155155
* @param {NonNegativeInteger} [byteOffset=0] - offset, in bytes, to the first byte in a provided buffer for the returned `struct` to reference
156-
* @param {NonNegativeInteger} [byteLength] - number of elements in the byte array
156+
* @param {NonNegativeInteger} [byteLength] - maximum number of elements in the byte array
157157
* @throws {RangeError} must provide sufficient memory to accommodate byte offset and view length requirements
158158
* @throws {TypeError} second argument must be a nonnegative integer
159159
* @throws {TypeError} third argument must be a nonnegative integer

0 commit comments

Comments
 (0)