From 4f8bf418e35c92e76cb45aabc290fc04f2a86092 Mon Sep 17 00:00:00 2001 From: ivishal-g Date: Tue, 10 Feb 2026 01:27:01 +0530 Subject: [PATCH] docs: improve doctests for complex number instances in math/base/special/cceilf --- 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: 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/cceilf/README.md | 9 +-------- .../@stdlib/math/base/special/cceilf/docs/repl.txt | 6 +----- .../math/base/special/cceilf/docs/types/index.d.ts | 10 +--------- .../@stdlib/math/base/special/cceilf/lib/index.js | 10 +--------- .../@stdlib/math/base/special/cceilf/lib/main.js | 10 +--------- .../@stdlib/math/base/special/cceilf/lib/native.js | 8 +------- 6 files changed, 6 insertions(+), 47 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cceilf/README.md b/lib/node_modules/@stdlib/math/base/special/cceilf/README.md index 8e2cf2c71be2..905a69d6e74d 100644 --- a/lib/node_modules/@stdlib/math/base/special/cceilf/README.md +++ b/lib/node_modules/@stdlib/math/base/special/cceilf/README.md @@ -36,17 +36,10 @@ Rounds each component of a single-precision complex floating-point number toward ```javascript var Complex64 = require( '@stdlib/complex/float32/ctor' ); -var real = require( '@stdlib/complex/float32/real' ); -var imag = require( '@stdlib/complex/float32/imag' ); var v = cceilf( new Complex64( -1.5, 2.5 ) ); -// returns +// returns [ -1.0, 3.0 ] -var re = real( v ); -// returns -1.0 - -var im = imag( v ); -// returns 3.0 ``` diff --git a/lib/node_modules/@stdlib/math/base/special/cceilf/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/cceilf/docs/repl.txt index 2e3c0b40b516..7995530dfa29 100644 --- a/lib/node_modules/@stdlib/math/base/special/cceilf/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/cceilf/docs/repl.txt @@ -16,11 +16,7 @@ Examples -------- > var v = {{alias}}( new {{alias:@stdlib/complex/float32/ctor}}( -1.5, 2.5 ) ) - - > var re = {{alias:@stdlib/complex/float32/real}}( v ) - -1.0 - > var im = {{alias:@stdlib/complex/float32/imag}}( v ) - 3.0 + [ -1.0, 3.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/math/base/special/cceilf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cceilf/docs/types/index.d.ts index b28c13f66a7b..4adafa3b9cd0 100644 --- a/lib/node_modules/@stdlib/math/base/special/cceilf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/cceilf/docs/types/index.d.ts @@ -30,17 +30,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 = cceilf( new Complex64( -1.5, 2.5 ) ); -* // returns -* -* var re = real( v ); -* // returns -1.0 -* -* var im = imag( v ); -* // returns 3.0 +* // returns [ -1.0, 3.0 ] */ declare function cceilf( z: Complex64 ): Complex64; diff --git a/lib/node_modules/@stdlib/math/base/special/cceilf/lib/index.js b/lib/node_modules/@stdlib/math/base/special/cceilf/lib/index.js index f5d737db4479..72680cdcc415 100644 --- a/lib/node_modules/@stdlib/math/base/special/cceilf/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/special/cceilf/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 cceilf = require( '@stdlib/math/base/special/cceilf' ); * * var v = cceilf( new Complex64( -1.5, 2.5 ) ); -* // returns -* -* var re = real( v ); -* // returns -1.0 -* -* var im = imag( v ); -* // returns 3.0 +* // returns [ -1.0, 3.0 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/math/base/special/cceilf/lib/main.js b/lib/node_modules/@stdlib/math/base/special/cceilf/lib/main.js index f92fc98e00c6..e0ed9da0bf6b 100644 --- a/lib/node_modules/@stdlib/math/base/special/cceilf/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/cceilf/lib/main.js @@ -36,17 +36,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 = cceilf( new Complex64( -1.5, 2.5 ) ); -* // returns -* -* var re = realf( v ); -* // returns -1.0 -* -* var im = imagf( v ); -* // returns 3.0 +* // returns [ -1.0, 3.0 ] */ function cceilf( z ) { return new Complex64( ceilf( realf( z ) ), ceilf( imagf( z ) ) ); diff --git a/lib/node_modules/@stdlib/math/base/special/cceilf/lib/native.js b/lib/node_modules/@stdlib/math/base/special/cceilf/lib/native.js index dd2fa34aa43c..929db2a38490 100644 --- a/lib/node_modules/@stdlib/math/base/special/cceilf/lib/native.js +++ b/lib/node_modules/@stdlib/math/base/special/cceilf/lib/native.js @@ -39,13 +39,7 @@ var addon = require( './../src/addon.node' ); * var imagf = require( '@stdlib/complex/float32/imag' ); * * var v = cceilf( new Complex64( -1.5, 2.5 ) ); -* // returns -* -* var re = realf( v ); -* // returns -1.0 -* -* var im = imagf( v ); -* // returns 3.0 +* // returns [ -1.0, 3.0 ] */ function cceilf( z ) { var v = addon( z );