Skip to content

Commit 913e3b7

Browse files
committed
docs: update data types
--- 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 c86bbc5 commit 913e3b7

File tree

6 files changed

+10
-10
lines changed
  • lib/node_modules/@stdlib/plot/vega/data/tidy

6 files changed

+10
-10
lines changed

lib/node_modules/@stdlib/plot/vega/data/tidy/from-matrix-columns/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ var DTYPE = 'float64'; // note: we don't use `dtype.index`, as that can be `int3
4343
/**
4444
* Converts the columns of a two-dimensional ndarray to "tidy" data sets.
4545
*
46-
* @param {ndarray} arr - input array
46+
* @param {ndarrayLike} arr - input array
4747
* @param {Array<string>} names - data set (column) names
4848
* @param {Array<string>} fields - list of field names
4949
* @returns {Array<DataSet>} array of data sets

lib/node_modules/@stdlib/plot/vega/data/tidy/from-paired-matrix-columns/lib/main.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ var pairedvectors2tidy = require( '@stdlib/plot/vega/data/tidy/from-paired-vecto
3434
*
3535
* - The function provided limited support for "broadcasting". If either ndarray contains only a single column, that column is broadcasted against all the columns in the other ndarray.
3636
*
37-
* @param {ndarray} x - first ndarray
38-
* @param {ndarray} y - second ndarray
37+
* @param {ndarrayLike} x - first ndarray
38+
* @param {ndarrayLike} y - second ndarray
3939
* @param {Array<string>} names - data set names
4040
* @param {Array<string>} fields - list of field names
4141
* @throws {Error} provided ndarrays must be broadcast-compatible

lib/node_modules/@stdlib/plot/vega/data/tidy/from-paired-vectors/lib/main.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ var vectors2tidy = require( '@stdlib/plot/vega/data/tidy/from-vectors' );
3232
*
3333
* - The function provided limited support for "broadcasting". If either list of ndarrays contains only a single ndarray, that ndarray is broadcasted against the ndarrays in the other list.
3434
*
35-
* @param {ArrayLikeObject<ArrayLikeObject<ndarray>>} list1 - first list of ndarrays
36-
* @param {ArrayLikeObject<ArrayLikeObject<ndarray>>} list2 - second list of ndarrays
35+
* @param {ArrayLikeObject<ArrayLikeObject<ndarrayLike>>} list1 - first list of ndarrays
36+
* @param {ArrayLikeObject<ArrayLikeObject<ndarrayLike>>} list2 - second list of ndarrays
3737
* @param {Array<string>} names - data set names
3838
* @param {Array<string>} fields - list of field names
3939
* @throws {Error} provided lists must be broadcast-compatible

lib/node_modules/@stdlib/plot/vega/data/tidy/from-vector/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ var DTYPE = 'float64'; // note: we don't use `dtype.index`, as that can be `int3
4242
/**
4343
* Converts a one-dimensional ndarray to a "tidy" data set.
4444
*
45-
* @param {ndarray} arr - input array
45+
* @param {ndarrayLike} arr - input array
4646
* @param {string} name - data set name
4747
* @param {Array<string>} fields - list of field names
4848
* @returns {DataSet} data set instance

lib/node_modules/@stdlib/plot/vega/data/tidy/from-vectors/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ var DataSet = require( '@stdlib/plot/vega/data/values' );
2929
/**
3030
* Converts a list of one-dimensional ndarrays to a "tidy" data set.
3131
*
32-
* @param {ArrayLikeObject<ndarray>} list - list of ndarrays
32+
* @param {ArrayLikeObject<ndarrayLike>} list - list of ndarrays
3333
* @param {string} name - data set name
3434
* @param {Array<string>} fields - list of field names
3535
* @returns {DataSet} data set instance

lib/node_modules/@stdlib/plot/vega/data/tidy/from-xy-arguments/lib/main.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ function names( len, start ) {
8787
* Converts a single argument to a list of tidy data sets.
8888
*
8989
* @private
90-
* @param {(Collection|ndarray)} arg - argument
90+
* @param {(Collection|ndarrayLike)} arg - argument
9191
* @param {Object} mapping - object mapping field names to encoding channels ('x', 'y', and 'z')
9292
* @throws {TypeError} must provide a valid argument
9393
* @returns {Array<DataSet>} list of data sets
@@ -210,8 +210,8 @@ function unary( arg, mapping ) {
210210
* Converts two argument to a list of tidy data sets.
211211
*
212212
* @private
213-
* @param {(Array|ndarray)} arg1 - first argument
214-
* @param {(Array|ndarray)} arg2 - second argument
213+
* @param {(Array|ndarrayLike)} arg1 - first argument
214+
* @param {(Array|ndarrayLike)} arg2 - second argument
215215
* @throws {TypeError} must provide a valid argument
216216
* @returns {Array<DataSet>} list of data sets
217217
*/

0 commit comments

Comments
 (0)