Skip to content

Commit 356e8a0

Browse files
committed
docs: use boolean typed array in 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: 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: passed - task: lint_license_headers status: passed ---
1 parent 7eab9c5 commit 356e8a0

File tree

1 file changed

+4
-4
lines changed
  • lib/node_modules/@stdlib/ndarray/flatten-by/docs/types

1 file changed

+4
-4
lines changed

lib/node_modules/@stdlib/ndarray/flatten-by/docs/types/index.d.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -192,14 +192,14 @@ declare function flattenBy<T extends ComplexLike = ComplexLike, U extends typedn
192192
* var strides = [ 2, 2, 1 ];
193193
* var offset = 0;
194194
*
195-
* var x = ndarray( 'uint8c', buffer, shape, strides, offset, 'row-major' );
195+
* var x = ndarray( 'bool', buffer, shape, strides, offset, 'row-major' );
196196
* // returns <ndarray>
197197
*
198198
* var y = flattenBy( x, invert );
199199
* // returns <ndarray>
200200
*
201201
* var arr = ndarray2array( y );
202-
* // returns [ 0, 1, 0, 1, 0, 1 ]
202+
* // returns [ false, true, false, true, false, true ]
203203
*/
204204
declare function flattenBy<T extends typedndarray<boolean> = typedndarray<boolean>, ThisArg = unknown>( x: T, fcn: Callback<boolean, T, boolean, ThisArg>, thisArg?: ThisParameterType<Callback<boolean, T, boolean, ThisArg>> ): T;
205205

@@ -340,7 +340,7 @@ declare function flattenBy<T extends ComplexLike = ComplexLike, U extends typedn
340340
* var strides = [ 2, 2, 1 ];
341341
* var offset = 0;
342342
*
343-
* var x = ndarray( 'uint8c', buffer, shape, strides, offset, 'row-major' );
343+
* var x = ndarray( 'bool', buffer, shape, strides, offset, 'row-major' );
344344
* // returns <ndarray>
345345
*
346346
* var opts = {
@@ -351,7 +351,7 @@ declare function flattenBy<T extends ComplexLike = ComplexLike, U extends typedn
351351
* // returns <ndarray>
352352
*
353353
* var arr = ndarray2array( y );
354-
* // returns [ 0, 1, 0, 1, 0, 1 ]
354+
* // returns [ false, true, false, true, false, true ]
355355
*/
356356
declare function flattenBy<T extends typedndarray<boolean> = typedndarray<boolean>, ThisArg = unknown>( x: T, options: BaseOptions, fcn: Callback<boolean, T, boolean, ThisArg>, thisArg?: ThisParameterType<Callback<boolean, T, boolean, ThisArg>> ): T;
357357

0 commit comments

Comments
 (0)