Skip to content

Commit dbfa538

Browse files
PlaneshifterPlaneshifter
committed
docs: fix example code in TSDoc declaration 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: 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 e65c0c3 commit dbfa538

File tree

4 files changed

+32
-32
lines changed

4 files changed

+32
-32
lines changed

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -150,8 +150,8 @@ interface Float32Vector {
150150
* var numel = require( '@stdlib/ndarray/numel' );
151151
* var ArrayBuffer = require( '@stdlib/array/buffer' );
152152
*
153-
* var buf = new ArrayBuffer( 32, 8 );
154-
* var arr = new Float32Vector( buf );
153+
* var buf = new ArrayBuffer( 32 );
154+
* var arr = new Float32Vector( buf, 8 );
155155
* // returns <ndarray>
156156
*
157157
* var len = numel( arr );
@@ -175,8 +175,8 @@ interface Float32Vector {
175175
* var numel = require( '@stdlib/ndarray/numel' );
176176
* var ArrayBuffer = require( '@stdlib/array/buffer' );
177177
*
178-
* var buf = new ArrayBuffer( 32, 8, 2 );
179-
* var arr = new Float32Vector( buf );
178+
* var buf = new ArrayBuffer( 32 );
179+
* var arr = new Float32Vector( buf, 8, 2 );
180180
* // returns <ndarray>
181181
*
182182
* var len = numel( arr );
@@ -284,8 +284,8 @@ interface Float32Vector {
284284
* var numel = require( '@stdlib/ndarray/numel' );
285285
* var ArrayBuffer = require( '@stdlib/array/buffer' );
286286
*
287-
* var buf = new ArrayBuffer( 32, 8 );
288-
* var arr = new Float32Vector( buf );
287+
* var buf = new ArrayBuffer( 32 );
288+
* var arr = new Float32Vector( buf, 8 );
289289
* // returns <ndarray>
290290
*
291291
* var len = numel( arr );
@@ -309,8 +309,8 @@ interface Float32Vector {
309309
* var numel = require( '@stdlib/ndarray/numel' );
310310
* var ArrayBuffer = require( '@stdlib/array/buffer' );
311311
*
312-
* var buf = new ArrayBuffer( 32, 8, 2 );
313-
* var arr = new Float32Vector( buf );
312+
* var buf = new ArrayBuffer( 32 );
313+
* var arr = new Float32Vector( buf, 8, 2 );
314314
* // returns <ndarray>
315315
*
316316
* var len = numel( arr );

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -150,8 +150,8 @@ interface Int16Vector {
150150
* var numel = require( '@stdlib/ndarray/numel' );
151151
* var ArrayBuffer = require( '@stdlib/array/buffer' );
152152
*
153-
* var buf = new ArrayBuffer( 32, 8 );
154-
* var arr = new Int16Vector( buf );
153+
* var buf = new ArrayBuffer( 32 );
154+
* var arr = new Int16Vector( buf, 8 );
155155
* // returns <ndarray>
156156
*
157157
* var len = numel( arr );
@@ -175,8 +175,8 @@ interface Int16Vector {
175175
* var numel = require( '@stdlib/ndarray/numel' );
176176
* var ArrayBuffer = require( '@stdlib/array/buffer' );
177177
*
178-
* var buf = new ArrayBuffer( 32, 8, 2 );
179-
* var arr = new Int16Vector( buf );
178+
* var buf = new ArrayBuffer( 32 );
179+
* var arr = new Int16Vector( buf, 8, 2 );
180180
* // returns <ndarray>
181181
*
182182
* var len = numel( arr );
@@ -284,8 +284,8 @@ interface Int16Vector {
284284
* var numel = require( '@stdlib/ndarray/numel' );
285285
* var ArrayBuffer = require( '@stdlib/array/buffer' );
286286
*
287-
* var buf = new ArrayBuffer( 32, 8 );
288-
* var arr = new Int16Vector( buf );
287+
* var buf = new ArrayBuffer( 32 );
288+
* var arr = new Int16Vector( buf, 8 );
289289
* // returns <ndarray>
290290
*
291291
* var len = numel( arr );
@@ -309,8 +309,8 @@ interface Int16Vector {
309309
* var numel = require( '@stdlib/ndarray/numel' );
310310
* var ArrayBuffer = require( '@stdlib/array/buffer' );
311311
*
312-
* var buf = new ArrayBuffer( 32, 8, 2 );
313-
* var arr = new Int16Vector( buf );
312+
* var buf = new ArrayBuffer( 32 );
313+
* var arr = new Int16Vector( buf, 8, 2 );
314314
* // returns <ndarray>
315315
*
316316
* var len = numel( arr );

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -150,8 +150,8 @@ interface Int32Vector {
150150
* var numel = require( '@stdlib/ndarray/numel' );
151151
* var ArrayBuffer = require( '@stdlib/array/buffer' );
152152
*
153-
* var buf = new ArrayBuffer( 32, 8 );
154-
* var arr = new Int32Vector( buf );
153+
* var buf = new ArrayBuffer( 32 );
154+
* var arr = new Int32Vector( buf, 8 );
155155
* // returns <ndarray>
156156
*
157157
* var len = numel( arr );
@@ -175,8 +175,8 @@ interface Int32Vector {
175175
* var numel = require( '@stdlib/ndarray/numel' );
176176
* var ArrayBuffer = require( '@stdlib/array/buffer' );
177177
*
178-
* var buf = new ArrayBuffer( 32, 8, 2 );
179-
* var arr = new Int32Vector( buf );
178+
* var buf = new ArrayBuffer( 32 );
179+
* var arr = new Int32Vector( buf, 8, 2 );
180180
* // returns <ndarray>
181181
*
182182
* var len = numel( arr );
@@ -284,8 +284,8 @@ interface Int32Vector {
284284
* var numel = require( '@stdlib/ndarray/numel' );
285285
* var ArrayBuffer = require( '@stdlib/array/buffer' );
286286
*
287-
* var buf = new ArrayBuffer( 32, 8 );
288-
* var arr = new Int32Vector( buf );
287+
* var buf = new ArrayBuffer( 32 );
288+
* var arr = new Int32Vector( buf, 8 );
289289
* // returns <ndarray>
290290
*
291291
* var len = numel( arr );
@@ -309,8 +309,8 @@ interface Int32Vector {
309309
* var numel = require( '@stdlib/ndarray/numel' );
310310
* var ArrayBuffer = require( '@stdlib/array/buffer' );
311311
*
312-
* var buf = new ArrayBuffer( 32, 8, 2 );
313-
* var arr = new Int32Vector( buf );
312+
* var buf = new ArrayBuffer( 32 );
313+
* var arr = new Int32Vector( buf, 8, 2 );
314314
* // returns <ndarray>
315315
*
316316
* var len = numel( arr );

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -150,8 +150,8 @@ interface Uint8Vector {
150150
* var numel = require( '@stdlib/ndarray/numel' );
151151
* var ArrayBuffer = require( '@stdlib/array/buffer' );
152152
*
153-
* var buf = new ArrayBuffer( 32, 8 );
154-
* var arr = new Uint8Vector( buf );
153+
* var buf = new ArrayBuffer( 32 );
154+
* var arr = new Uint8Vector( buf, 8 );
155155
* // returns <ndarray>
156156
*
157157
* var len = numel( arr );
@@ -175,8 +175,8 @@ interface Uint8Vector {
175175
* var numel = require( '@stdlib/ndarray/numel' );
176176
* var ArrayBuffer = require( '@stdlib/array/buffer' );
177177
*
178-
* var buf = new ArrayBuffer( 32, 8, 2 );
179-
* var arr = new Uint8Vector( buf );
178+
* var buf = new ArrayBuffer( 32 );
179+
* var arr = new Uint8Vector( buf, 8, 2 );
180180
* // returns <ndarray>
181181
*
182182
* var len = numel( arr );
@@ -284,8 +284,8 @@ interface Uint8Vector {
284284
* var numel = require( '@stdlib/ndarray/numel' );
285285
* var ArrayBuffer = require( '@stdlib/array/buffer' );
286286
*
287-
* var buf = new ArrayBuffer( 32, 8 );
288-
* var arr = new Uint8Vector( buf );
287+
* var buf = new ArrayBuffer( 32 );
288+
* var arr = new Uint8Vector( buf, 8 );
289289
* // returns <ndarray>
290290
*
291291
* var len = numel( arr );
@@ -309,8 +309,8 @@ interface Uint8Vector {
309309
* var numel = require( '@stdlib/ndarray/numel' );
310310
* var ArrayBuffer = require( '@stdlib/array/buffer' );
311311
*
312-
* var buf = new ArrayBuffer( 32, 8, 2 );
313-
* var arr = new Uint8Vector( buf );
312+
* var buf = new ArrayBuffer( 32 );
313+
* var arr = new Uint8Vector( buf, 8, 2 );
314314
* // returns <ndarray>
315315
*
316316
* var len = numel( arr );

0 commit comments

Comments
 (0)