From 0d997c7e7ee8f8ac9ce34e56dbec21d3430edf86 Mon Sep 17 00:00:00 2001 From: Aryan Kumar Date: Fri, 12 Dec 2025 17:14:23 +0000 Subject: [PATCH 1/2] docs: improve doctests for complex number instances in math/base/special/cflipsignf --- 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: passed - 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 --- --- .../@stdlib/math/base/special/cflipsignf/docs/repl.txt | 6 +----- .../math/base/special/cflipsignf/docs/types/index.d.ts | 10 +--------- .../@stdlib/math/base/special/cflipsignf/lib/index.js | 10 +--------- .../@stdlib/math/base/special/cflipsignf/lib/main.js | 10 +--------- .../@stdlib/math/base/special/cflipsignf/lib/native.js | 10 +--------- 5 files changed, 5 insertions(+), 41 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cflipsignf/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/cflipsignf/docs/repl.txt index 002f3f1eeb3c..1b49741f1236 100644 --- a/lib/node_modules/@stdlib/math/base/special/cflipsignf/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/cflipsignf/docs/repl.txt @@ -19,11 +19,7 @@ Examples -------- > var v = {{alias}}( new {{alias:@stdlib/complex/float32/ctor}}( -4.0, 5.0 ), -9.0 ) - - > var re = {{alias:@stdlib/complex/float32/real}}( v ) - 4.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( v ) - -5.0 + [ 4.0, -5.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/math/base/special/cflipsignf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cflipsignf/docs/types/index.d.ts index 5fa496304e31..4208bdd29532 100644 --- a/lib/node_modules/@stdlib/math/base/special/cflipsignf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/cflipsignf/docs/types/index.d.ts @@ -31,17 +31,9 @@ import { Complex64 } from '@stdlib/types/complex'; * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var real = require( '@stdlib/complex/float32/real' ); -* var imag = require( '@stdlib/complex/float32/imag' ); * * var v = cflipsignf( new Complex64( -4.0, 5.0 ), -55.0 ); -* // returns -* -* var re = real( v ); -* // returns 4.0 -* -* var im = imag( v ); -* // returns -5.0 +* // returns [ 4.0, -5.0 ] */ declare function cflipsignf( z: Complex64, y: number ): Complex64; diff --git a/lib/node_modules/@stdlib/math/base/special/cflipsignf/lib/index.js b/lib/node_modules/@stdlib/math/base/special/cflipsignf/lib/index.js index 8a19a7df7b93..1ca02686eba3 100644 --- a/lib/node_modules/@stdlib/math/base/special/cflipsignf/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/special/cflipsignf/lib/index.js @@ -25,18 +25,10 @@ * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var real = require( '@stdlib/complex/float32/real' ); -* var imag = require( '@stdlib/complex/float32/imag' ); * var cflipsignf = require( '@stdlib/math/base/special/cflipsignf' ); * * var v = cflipsignf( new Complex64( -4.0, 5.0 ), -55.0 ); -* // returns -* -* var re = real( v ); -* // returns 4.0 -* -* var im = imag( v ); -* // returns -5.0 +* // returns [ 4.0, -5.0 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/math/base/special/cflipsignf/lib/main.js b/lib/node_modules/@stdlib/math/base/special/cflipsignf/lib/main.js index 7dbdeee8ffc3..bc758e092039 100644 --- a/lib/node_modules/@stdlib/math/base/special/cflipsignf/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/cflipsignf/lib/main.js @@ -37,17 +37,9 @@ var imagf = require( '@stdlib/complex/float32/imag' ); * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var realf = require( '@stdlib/complex/float32/real' ); -* var imagf = require( '@stdlib/complex/float32/imag' ); * * var v = cflipsignf( new Complex64( -4.0, 5.0 ), -55.0 ); -* // returns -* -* var re = realf( v ); -* // returns 4.0 -* -* var im = imagf( v ); -* // returns -5.0 +* // returns [ 4.0, -5.0 ] */ function cflipsignf( z, y ) { var re = realf( z ); diff --git a/lib/node_modules/@stdlib/math/base/special/cflipsignf/lib/native.js b/lib/node_modules/@stdlib/math/base/special/cflipsignf/lib/native.js index 2919e602e20c..b57812a7dd1a 100644 --- a/lib/node_modules/@stdlib/math/base/special/cflipsignf/lib/native.js +++ b/lib/node_modules/@stdlib/math/base/special/cflipsignf/lib/native.js @@ -36,17 +36,9 @@ var addon = require( './../src/addon.node' ); * * @example * var Complex64 = require( '@stdlib/complex/float32/ctor' ); -* var real = require( '@stdlib/complex/float32/real' ); -* var imag = require( '@stdlib/complex/float32/imag' ); * * var v = cflipsignf( new Complex64( -4.0, 5.5 ), -55.0 ); -* // returns -* -* var re = real( v ); -* // returns 4.0 -* -* var im = imag( v ); -* // returns -5.5 +* // returns [ 4.0, -5.5 ] */ function cflipsignf( z, y ) { var v = addon( z, y ); From 14c1c5e578e3eca974a202cc79407b1e517b5727 Mon Sep 17 00:00:00 2001 From: Aryan Kumar Date: Fri, 12 Dec 2025 17:17:53 +0000 Subject: [PATCH 2/2] docs: improve doctests for complex number instances in math/base/special/cflipsignf --- 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: passed - 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: na - task: lint_license_headers status: passed --- --- .../@stdlib/math/base/special/cflipsignf/README.md | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cflipsignf/README.md b/lib/node_modules/@stdlib/math/base/special/cflipsignf/README.md index 20d11c6904a5..aa983fc53791 100644 --- a/lib/node_modules/@stdlib/math/base/special/cflipsignf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/cflipsignf/README.md @@ -46,17 +46,9 @@ Returns a single-precision complex floating-point number with the same magnitude ```javascript var Complex64 = require( '@stdlib/complex/float32/ctor' ); -var real = require( '@stdlib/complex/float32/real' ); -var imag = require( '@stdlib/complex/float32/imag' ); var v = cflipsignf( new Complex64( -4.0, 5.0 ), -1.0 ); -// returns - -var re = real( v ); -// returns 4.0 - -var im = imag( v ); -// returns -5.0 +// returns [ 4.0, -5.0 ] ```