Skip to content

Commit 5471fc4

Browse files
committed
docs: fix descriptions
--- 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: 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 7f4b555 commit 5471fc4

File tree

1 file changed

+11
-11
lines changed
  • lib/node_modules/@stdlib/ndarray/vector/ctor/docs/types

1 file changed

+11
-11
lines changed

lib/node_modules/@stdlib/ndarray/vector/ctor/docs/types/index.d.ts

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ interface GenericVector {
7676
/**
7777
* Creates a vector (i.e., a one-dimensional ndarray).
7878
*
79-
* @param obj - array-like object or iterable from which to generate a typed array
79+
* @param obj - array-like object or iterable from which to generate a vector
8080
* @param options - function options
8181
* @param options.readonly - boolean indicating whether to return a read-only vector
8282
* @param options.mode - specifies how to handle indices which exceed vector dimensions
@@ -116,7 +116,7 @@ interface TypedVector<T extends keyof TypedDataTypeMap> {
116116
/**
117117
* Creates a vector (i.e., a one-dimensional ndarray).
118118
*
119-
* @param obj - array-like object or iterable from which to generate a typed array
119+
* @param obj - array-like object or iterable from which to generate a vector
120120
* @param options - function options
121121
* @param options.readonly - boolean indicating whether to return a read-only vector
122122
* @param options.mode - specifies how to handle indices which exceed vector dimensions
@@ -141,7 +141,7 @@ interface TypedVector<T extends keyof TypedDataTypeMap> {
141141
* Creates a vector (i.e., a one-dimensional ndarray).
142142
*
143143
* @param buffer - underlying ArrayBuffer
144-
* @param byteOffset - integer byte offset specifying the location of the first typed array element
144+
* @param byteOffset - integer byte offset specifying the location of the first vector element
145145
* @param options - function options
146146
* @param options.readonly - boolean indicating whether to return a read-only vector
147147
* @param options.mode - specifies how to handle indices which exceed vector dimensions
@@ -154,7 +154,7 @@ interface TypedVector<T extends keyof TypedDataTypeMap> {
154154
* Creates a vector (i.e., a one-dimensional ndarray).
155155
*
156156
* @param buffer - underlying ArrayBuffer
157-
* @param byteOffset - integer byte offset specifying the location of the first typed array element
157+
* @param byteOffset - integer byte offset specifying the location of the first vector element
158158
* @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer
159159
* @param options - function options
160160
* @param options.readonly - boolean indicating whether to return a read-only vector
@@ -324,7 +324,7 @@ interface Vector {
324324
/**
325325
* Creates a vector (i.e., a one-dimensional ndarray).
326326
*
327-
* @param obj - array-like object or iterable from which to generate a typed array
327+
* @param obj - array-like object or iterable from which to generate a vector
328328
* @param dtype - data type (default: 'float64')
329329
* @param options - function options
330330
* @param options.readonly - boolean indicating whether to return a read-only vector
@@ -376,7 +376,7 @@ interface Vector {
376376
/**
377377
* Creates a vector (i.e., a one-dimensional ndarray).
378378
*
379-
* @param obj - array-like object or iterable from which to generate a typed array
379+
* @param obj - array-like object or iterable from which to generate a vector
380380
* @param options - function options
381381
* @param options.readonly - boolean indicating whether to return a read-only vector
382382
* @param options.mode - specifies how to handle indices which exceed vector dimensions
@@ -487,7 +487,7 @@ interface Vector {
487487
* Creates a vector (i.e., a one-dimensional ndarray).
488488
*
489489
* @param buffer - underlying ArrayBuffer
490-
* @param byteOffset - integer byte offset specifying the location of the first typed array element (default: 0)
490+
* @param byteOffset - integer byte offset specifying the location of the first vector element (default: 0)
491491
* @param dtype - data type (default: 'float64')
492492
* @param options - function options
493493
* @param options.readonly - boolean indicating whether to return a read-only vector
@@ -546,7 +546,7 @@ interface Vector {
546546
* Creates a vector (i.e., a one-dimensional ndarray).
547547
*
548548
* @param buffer - underlying ArrayBuffer
549-
* @param byteOffset - integer byte offset specifying the location of the first typed array element
549+
* @param byteOffset - integer byte offset specifying the location of the first vector element
550550
* @param options - function options
551551
* @param options.readonly - boolean indicating whether to return a read-only vector
552552
* @param options.mode - specifies how to handle indices which exceed vector dimensions
@@ -589,7 +589,7 @@ interface Vector {
589589
* Creates a vector (i.e., a one-dimensional ndarray).
590590
*
591591
* @param buffer - underlying ArrayBuffer
592-
* @param byteOffset - integer byte offset specifying the location of the first typed array element (default: 0)
592+
* @param byteOffset - integer byte offset specifying the location of the first vector element (default: 0)
593593
* @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer
594594
* @param dtype - data type (default: 'float64')
595595
* @param options - function options
@@ -647,7 +647,7 @@ interface Vector {
647647
* Creates a vector (i.e., a one-dimensional ndarray).
648648
*
649649
* @param buffer - underlying ArrayBuffer
650-
* @param byteOffset - integer byte offset specifying the location of the first typed array element
650+
* @param byteOffset - integer byte offset specifying the location of the first vector element
651651
* @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer
652652
* @param options - function options
653653
* @param options.readonly - boolean indicating whether to return a read-only vector
@@ -812,7 +812,7 @@ interface Vector {
812812
* Creates a vector (i.e., a one-dimensional ndarray).
813813
*
814814
* @param arg - length, typed array, array-like object, buffer, or iterable
815-
* @param byteOffset - integer byte offset specifying the location of the first typed array element (default: 0)
815+
* @param byteOffset - integer byte offset specifying the location of the first vector element (default: 0)
816816
* @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer
817817
* @param dtype - data type (default: 'float64')
818818
* @param options - function options

0 commit comments

Comments
 (0)