docs: update example code in namespace TSDoc declarations

Planeshifter · Planeshifter · commit 1dcf1013f5f6 · 2025-12-04T23:01:47.000-06: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: 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
---
diff --git a/lib/node_modules/@stdlib/lapack/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/lapack/base/docs/types/index.d.ts
@@ -904,41 +904,25 @@ interface Namespace {
 	*
 	* @example
 	* var Complex128Array = require( '@stdlib/array/complex128' );
-	* var real = require( '@stdlib/complex/float64/real' );
-	* var imag = require( '@stdlib/complex/float64/imag' );
 	*
 	* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
 	* var B = new Complex128Array( 4 );
 	*
 	* ns.zlacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 );
 	*
 	* var z = B.get( 0 );
-	* // returns <Complex128>
-	*
-	* var v = real( z );
-	* // returns 1.0
-	*
-	* v = imag( z );
-	* // returns 2.0
+	* // returns <Complex128>[ 1.0, 2.0 ]
 	*
 	* @example
 	* var Complex128Array = require( '@stdlib/array/complex128' );
-	* var real = require( '@stdlib/complex/float64/real' );
-	* var imag = require( '@stdlib/complex/float64/imag' );
 	*
 	* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] );
 	* var B = new Complex128Array( 12 );
 	*
 	* ns.zlacpy.ndarray( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
 	*
 	* var z = B.get( 2 );
-	* // returns <Complex128>
-	*
-	* var v = real( z );
-	* // returns 3.0
-	*
-	* v = imag( z );
-	* // returns 4.0
+	* // returns <Complex128>[ 3.0, 4.0 ]
 	*/
 	zlacpy: typeof zlacpy;
 
diff --git a/lib/node_modules/@stdlib/math/base/special/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/docs/types/index.d.ts
@@ -2943,17 +2943,9 @@ interface Namespace {
 	*
 	* @example
 	* var Complex64 = require( '@stdlib/complex/float32/ctor' );
-	* var real = require( '@stdlib/complex/float32/real' );
-	* var imag = require( '@stdlib/complex/float32/imag' );
 	*
 	* var v = ns.cfloorf( new Complex64( 5.5, 3.3 ) );
-	* // returns <Complex64>
-	*
-	* var re = real( v );
-	* // returns 5.0
-	*
-	* var im = imag( v );
-	* // returns 3.0
+	* // returns <Complex64>[ 5.0, 3.0 ]
 	*/
 	cfloorf: typeof cfloorf;
 

Original file line number	Diff line number	Diff line change
`@@ -904,41 +904,25 @@ interface Namespace {`
`904`	`904`	`*`
`905`	`905`	`* @example`
`906`	`906`	`* var Complex128Array = require( '@stdlib/array/complex128' );`
`907`		`- * var real = require( '@stdlib/complex/float64/real' );`
`908`		`- * var imag = require( '@stdlib/complex/float64/imag' );`
`909`	`907`	`*`
`910`	`908`	`* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );`
`911`	`909`	`* var B = new Complex128Array( 4 );`
`912`	`910`	`*`
`913`	`911`	`* ns.zlacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 );`
`914`	`912`	`*`
`915`	`913`	`* var z = B.get( 0 );`
`916`		`- * // returns <Complex128>`
`917`		`- *`
`918`		`- * var v = real( z );`
`919`		`- * // returns 1.0`
`920`		`- *`
`921`		`- * v = imag( z );`
`922`		`- * // returns 2.0`
	`914`	`+ * // returns <Complex128>[ 1.0, 2.0 ]`
`923`	`915`	`*`
`924`	`916`	`* @example`
`925`	`917`	`* var Complex128Array = require( '@stdlib/array/complex128' );`
`926`		`- * var real = require( '@stdlib/complex/float64/real' );`
`927`		`- * var imag = require( '@stdlib/complex/float64/imag' );`
`928`	`918`	`*`
`929`	`919`	`* var A = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] );`
`930`	`920`	`* var B = new Complex128Array( 12 );`
`931`	`921`	`*`
`932`	`922`	`* ns.zlacpy.ndarray( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );`
`933`	`923`	`*`
`934`	`924`	`* var z = B.get( 2 );`
`935`		`- * // returns <Complex128>`
`936`		`- *`
`937`		`- * var v = real( z );`
`938`		`- * // returns 3.0`
`939`		`- *`
`940`		`- * v = imag( z );`
`941`		`- * // returns 4.0`
	`925`	`+ * // returns <Complex128>[ 3.0, 4.0 ]`
`942`	`926`	`*/`
`943`	`927`	`zlacpy: typeof zlacpy;`
`944`	`928`