Skip to content

Commit 157f4f4

Browse files
committed
docs: update comments
--- 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: passed - task: lint_license_headers status: passed ---
1 parent 60ba865 commit 157f4f4

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

lib/node_modules/@stdlib/ndarray/flatten/docs/types/test.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ import flatten = require( './index' );
8484
flatten( zeros( 'generic', [ 2, 2, 2 ], 'row-major' ), ( x: number ): number => x ); // $ExpectError
8585
}
8686

87-
// The compiler throws an error if the function is provided a second argument with invalid `depth` option...
87+
// The compiler throws an error if the function is provided a second argument with an invalid `depth` option...
8888
{
8989
flatten( zeros( 'float64', [ 2, 2, 2 ], 'row-major' ), { 'depth': '5' } ); // $ExpectError
9090
flatten( zeros( 'float64', [ 2, 2, 2 ], 'row-major' ), { 'depth': true } ); // $ExpectError
@@ -108,7 +108,7 @@ import flatten = require( './index' );
108108
flatten( zeros( 'generic', [ 2, 2, 2 ], 'row-major' ), { 'depth': ( x: number ): number => x } ); // $ExpectError
109109
}
110110

111-
// The compiler throws an error if the function is provided a second argument with invalid `order` option...
111+
// The compiler throws an error if the function is provided a second argument with an invalid `order` option...
112112
{
113113
flatten( zeros( 'float64', [ 2, 2, 2 ], 'row-major' ), { 'order': '5' } ); // $ExpectError
114114
flatten( zeros( 'float64', [ 2, 2, 2 ], 'row-major' ), { 'order': true } ); // $ExpectError
@@ -132,7 +132,7 @@ import flatten = require( './index' );
132132
flatten( zeros( 'generic', [ 2, 2, 2 ], 'row-major' ), { 'order': ( x: number ): number => x } ); // $ExpectError
133133
}
134134

135-
// The compiler throws an error if the function is provided a second argument with invalid `dtype` option...
135+
// The compiler throws an error if the function is provided a second argument with an invalid `dtype` option...
136136
{
137137
flatten( zeros( 'float64', [ 2, 2, 2 ], 'row-major' ), { 'dtype': '5' } ); // $ExpectError
138138
flatten( zeros( 'float64', [ 2, 2, 2 ], 'row-major' ), { 'dtype': true } ); // $ExpectError

lib/node_modules/@stdlib/ndarray/flatten/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,7 @@ function flatten( x, options ) {
349349
'dtype': opts.dtype
350350
});
351351

352-
// Create a view on top of output ndarray having the same shape as the input ndarray:
352+
// Create a view on top of the output ndarray having the same shape as the input ndarray:
353353
st = ( xsh.length > 0 ) ? shape2strides( xsh, opts.order ) : [ 0 ];
354354
view = ndarray( opts.dtype, getData( y ), xsh, st, 0, opts.order );
355355

0 commit comments

Comments
 (0)