docs: update examples

kgryte · kgryte · commit 384bc19cdc6d · 2025-05-17T00:30:05.000-07:00
---
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
---
diff --git a/lib/node_modules/@stdlib/ndarray/vector/ctor/lib/index.js b/lib/node_modules/@stdlib/ndarray/vector/ctor/lib/index.js
@@ -24,9 +24,9 @@
 * @module @stdlib/ndarray/vector/ctor
 *
 * @example
-* var Vector = require( '@stdlib/ndarray/vector/ctor' );
+* var vector = require( '@stdlib/ndarray/vector/ctor' );
 *
-* var v = new Vector();
+* var v = vector();
 * // returns <ndarray>
 *
 * var len = v.length;
@@ -36,9 +36,9 @@
 * // returns 'float64'
 *
 * @example
-* var Vector = require( '@stdlib/ndarray/vector/ctor' );
+* var vector = require( '@stdlib/ndarray/vector/ctor' );
 *
-* var v = new Vector( 2 );
+* var v = vector( 2 );
 * // returns <ndarray>
 *
 * var len = v.length;
@@ -48,9 +48,9 @@
 * // returns 'float64'
 *
 * @example
-* var Vector = require( '@stdlib/ndarray/vector/ctor' );
+* var vector = require( '@stdlib/ndarray/vector/ctor' );
 *
-* var v = new Vector( [ 1.0, 2.0 ] );
+* var v = vector( [ 1.0, 2.0 ] );
 * // returns <ndarray>
 *
 * var len = v.length;
@@ -60,9 +60,9 @@
 * // returns 'float64'
 *
 * @example
-* var Vector = require( '@stdlib/ndarray/vector/ctor' );
+* var vector = require( '@stdlib/ndarray/vector/ctor' );
 *
-* var v = new Vector( [ 1.0, 2.0 ], 'float32' );
+* var v = vector( [ 1.0, 2.0 ], 'float32' );
 * // returns <ndarray>
 *
 * var len = v.length;
@@ -73,10 +73,10 @@
 *
 * @example
 * var ArrayBuffer = require( '@stdlib/array/buffer' );
-* var Vector = require( '@stdlib/ndarray/vector/ctor' );
+* var vector = require( '@stdlib/ndarray/vector/ctor' );
 *
 * var buf = new ArrayBuffer( 32 );
-* var v = new Vector( buf );
+* var v = vector( buf );
 * // returns <ndarray>
 *
 * var len = v.length;
@@ -87,10 +87,10 @@
 *
 * @example
 * var ArrayBuffer = require( '@stdlib/array/buffer' );
-* var Vector = require( '@stdlib/ndarray/vector/ctor' );
+* var vector = require( '@stdlib/ndarray/vector/ctor' );
 *
 * var buf = new ArrayBuffer( 32 );
-* var v = new Vector( buf, 16 );
+* var v = vector( buf, 16 );
 * // returns <ndarray>
 *
 * var len = v.length;
@@ -101,10 +101,10 @@
 *
 * @example
 * var ArrayBuffer = require( '@stdlib/array/buffer' );
-* var Vector = require( '@stdlib/ndarray/vector/ctor' );
+* var vector = require( '@stdlib/ndarray/vector/ctor' );
 *
 * var buf = new ArrayBuffer( 64 );
-* var v = new Vector( buf, 16, 2 );
+* var v = vector( buf, 16, 2 );
 * // returns <ndarray>
 *
 * var len = v.length;

Original file line number	Diff line number	Diff line change
`@@ -24,9 +24,9 @@`
`24`	`24`	`* @module @stdlib/ndarray/vector/ctor`
`25`	`25`	`*`
`26`	`26`	`* @example`
`27`		`-* var Vector = require( '@stdlib/ndarray/vector/ctor' );`
	`27`	`+* var vector = require( '@stdlib/ndarray/vector/ctor' );`
`28`	`28`	`*`
`29`		`-* var v = new Vector();`
	`29`	`+* var v = vector();`
`30`	`30`	`* // returns <ndarray>`
`31`	`31`	`*`
`32`	`32`	`* var len = v.length;`
`@@ -36,9 +36,9 @@`
`36`	`36`	`* // returns 'float64'`
`37`	`37`	`*`
`38`	`38`	`* @example`
`39`		`-* var Vector = require( '@stdlib/ndarray/vector/ctor' );`
	`39`	`+* var vector = require( '@stdlib/ndarray/vector/ctor' );`
`40`	`40`	`*`
`41`		`-* var v = new Vector( 2 );`
	`41`	`+* var v = vector( 2 );`
`42`	`42`	`* // returns <ndarray>`
`43`	`43`	`*`
`44`	`44`	`* var len = v.length;`
`@@ -48,9 +48,9 @@`
`48`	`48`	`* // returns 'float64'`
`49`	`49`	`*`
`50`	`50`	`* @example`
`51`		`-* var Vector = require( '@stdlib/ndarray/vector/ctor' );`
	`51`	`+* var vector = require( '@stdlib/ndarray/vector/ctor' );`
`52`	`52`	`*`
`53`		`-* var v = new Vector( [ 1.0, 2.0 ] );`
	`53`	`+* var v = vector( [ 1.0, 2.0 ] );`
`54`	`54`	`* // returns <ndarray>`
`55`	`55`	`*`
`56`	`56`	`* var len = v.length;`
`@@ -60,9 +60,9 @@`
`60`	`60`	`* // returns 'float64'`
`61`	`61`	`*`
`62`	`62`	`* @example`
`63`		`-* var Vector = require( '@stdlib/ndarray/vector/ctor' );`
	`63`	`+* var vector = require( '@stdlib/ndarray/vector/ctor' );`
`64`	`64`	`*`
`65`		`-* var v = new Vector( [ 1.0, 2.0 ], 'float32' );`
	`65`	`+* var v = vector( [ 1.0, 2.0 ], 'float32' );`
`66`	`66`	`* // returns <ndarray>`
`67`	`67`	`*`
`68`	`68`	`* var len = v.length;`
`@@ -73,10 +73,10 @@`
`73`	`73`	`*`
`74`	`74`	`* @example`
`75`	`75`	`* var ArrayBuffer = require( '@stdlib/array/buffer' );`
`76`		`-* var Vector = require( '@stdlib/ndarray/vector/ctor' );`
	`76`	`+* var vector = require( '@stdlib/ndarray/vector/ctor' );`
`77`	`77`	`*`
`78`	`78`	`* var buf = new ArrayBuffer( 32 );`
`79`		`-* var v = new Vector( buf );`
	`79`	`+* var v = vector( buf );`
`80`	`80`	`* // returns <ndarray>`
`81`	`81`	`*`
`82`	`82`	`* var len = v.length;`
`@@ -87,10 +87,10 @@`
`87`	`87`	`*`
`88`	`88`	`* @example`
`89`	`89`	`* var ArrayBuffer = require( '@stdlib/array/buffer' );`
`90`		`-* var Vector = require( '@stdlib/ndarray/vector/ctor' );`
	`90`	`+* var vector = require( '@stdlib/ndarray/vector/ctor' );`
`91`	`91`	`*`
`92`	`92`	`* var buf = new ArrayBuffer( 32 );`
`93`		`-* var v = new Vector( buf, 16 );`
	`93`	`+* var v = vector( buf, 16 );`
`94`	`94`	`* // returns <ndarray>`
`95`	`95`	`*`
`96`	`96`	`* var len = v.length;`
`@@ -101,10 +101,10 @@`
`101`	`101`	`*`
`102`	`102`	`* @example`
`103`	`103`	`* var ArrayBuffer = require( '@stdlib/array/buffer' );`
`104`		`-* var Vector = require( '@stdlib/ndarray/vector/ctor' );`
	`104`	`+* var vector = require( '@stdlib/ndarray/vector/ctor' );`
`105`	`105`	`*`
`106`	`106`	`* var buf = new ArrayBuffer( 64 );`
`107`		`-* var v = new Vector( buf, 16, 2 );`
	`107`	`+* var v = vector( buf, 16, 2 );`
`108`	`108`	`* // returns <ndarray>`
`109`	`109`	`*`
`110`	`110`	`* var len = v.length;`