From 5514503480aac90175d4f456357f090355c00cc5 Mon Sep 17 00:00:00 2001 From: fiboNacci1163 Date: Sat, 1 Aug 2026 23:36:44 +0600 Subject: [PATCH] docs: improve doctests for complex number instances --- 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_pkg_readmes status: na - task: lint_markdown_docs status: na - 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 --- --- .../base/special/ccis/docs/types/index.d.ts | 20 ++----------------- .../math/base/special/docs/types/index.d.ts | 20 ++----------------- 2 files changed, 4 insertions(+), 36 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/ccis/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/ccis/docs/types/index.d.ts index 97761cacd6cd..8fcf52aa67a0 100644 --- a/lib/node_modules/@stdlib/math/base/special/ccis/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/ccis/docs/types/index.d.ts @@ -30,37 +30,21 @@ import { Complex128 } from '@stdlib/types/complex'; * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var z = new Complex128( 0.0, 0.0 ); * // returns * * var out = ccis( z ); -* // returns -* -* var re = real( out ); -* // returns 1.0 -* -* var im = imag( out ); -* // returns 0.0 +* // returns [ 1.0, 0.0 ] * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var z = new Complex128( 1.0, 0.0 ); * // returns * * var out = ccis( z ); -* // returns -* -* var re = real( out ); -* // returns ~0.540 -* -* var im = imag( out ); -* // returns ~0.841 +* // returns [ ~0.540, ~0.841 ] */ declare function ccis( z: Complex128 ): Complex128; 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 index de091e0f9c44..08bee1f4a29d 100644 --- 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 @@ -2602,37 +2602,21 @@ interface Namespace { * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); - * var real = require( '@stdlib/complex/float64/real' ); - * var imag = require( '@stdlib/complex/float64/imag' ); * * var z = new Complex128( 0.0, 0.0 ); * // returns * * var out = ns.ccis( z ); - * // returns - * - * var re = real( out ); - * // returns 1.0 - * - * var im = imag( out ); - * // returns 0.0 + * // returns [ 1.0, 0.0 ] * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); - * var real = require( '@stdlib/complex/float64/real' ); - * var imag = require( '@stdlib/complex/float64/imag' ); * * var z = new Complex128( 1.0, 0.0 ); * // returns * * var out = ns.ccis( z ); - * // returns - * - * var re = real( out ); - * // returns ~0.540 - * - * var im = imag( out ); - * // returns ~0.841 + * // returns [ ~0.540, ~0.841 ] */ ccis: typeof ccis;