From 6d10ab6214a4902876dc9313ea0f3cfd124b1483 Mon Sep 17 00:00:00 2001 From: Aryan Kumar Date: Fri, 12 Dec 2025 16:19:30 +0000 Subject: [PATCH] docs: improve doctests for complex number instances in math/base/special/cceil --- 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/cceil/docs/repl.txt | 6 +----- .../math/base/special/cceil/docs/types/index.d.ts | 10 +--------- .../@stdlib/math/base/special/cceil/lib/index.js | 10 +--------- .../@stdlib/math/base/special/cceil/lib/main.js | 10 +--------- .../@stdlib/math/base/special/cceil/lib/native.js | 10 +--------- 5 files changed, 5 insertions(+), 41 deletions(-) diff --git a/lib/node_modules/@stdlib/math/base/special/cceil/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/cceil/docs/repl.txt index accccf489de1..373d7a3bb369 100644 --- a/lib/node_modules/@stdlib/math/base/special/cceil/docs/repl.txt +++ b/lib/node_modules/@stdlib/math/base/special/cceil/docs/repl.txt @@ -16,11 +16,7 @@ Examples -------- > var v = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( -1.5, 2.5 ) ) - - > var re = {{alias:@stdlib/complex/float64/real}}( v ) - -1.0 - > var im = {{alias:@stdlib/complex/float64/imag}}( v ) - 3.0 + [ -1.0, 3.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/math/base/special/cceil/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/cceil/docs/types/index.d.ts index 4b0c2c0fc0d7..4a9e1d83bab0 100644 --- a/lib/node_modules/@stdlib/math/base/special/cceil/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/special/cceil/docs/types/index.d.ts @@ -30,17 +30,9 @@ 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 v = cceil( new Complex128( -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 cceil( z: Complex128 ): Complex128; diff --git a/lib/node_modules/@stdlib/math/base/special/cceil/lib/index.js b/lib/node_modules/@stdlib/math/base/special/cceil/lib/index.js index 64b2b707d9b6..a5e99c8ba44e 100644 --- a/lib/node_modules/@stdlib/math/base/special/cceil/lib/index.js +++ b/lib/node_modules/@stdlib/math/base/special/cceil/lib/index.js @@ -25,18 +25,10 @@ * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * var cceil = require( '@stdlib/math/base/special/cceil' ); * * var v = cceil( new Complex128( -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/cceil/lib/main.js b/lib/node_modules/@stdlib/math/base/special/cceil/lib/main.js index a4bc47859f85..6d1abbfb02aa 100644 --- a/lib/node_modules/@stdlib/math/base/special/cceil/lib/main.js +++ b/lib/node_modules/@stdlib/math/base/special/cceil/lib/main.js @@ -36,17 +36,9 @@ var imag = require( '@stdlib/complex/float64/imag' ); * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var v = cceil( new Complex128( -1.5, 2.5 ) ); -* // returns -* -* var re = real( v ); -* // returns -1.0 -* -* var im = imag( v ); -* // returns 3.0 +* // returns [ -1.0, 3.0 ] */ function cceil( z ) { return new Complex128( ceil( real( z ) ), ceil( imag( z ) ) ); diff --git a/lib/node_modules/@stdlib/math/base/special/cceil/lib/native.js b/lib/node_modules/@stdlib/math/base/special/cceil/lib/native.js index 1d82de4fb39e..21340589eba2 100644 --- a/lib/node_modules/@stdlib/math/base/special/cceil/lib/native.js +++ b/lib/node_modules/@stdlib/math/base/special/cceil/lib/native.js @@ -35,17 +35,9 @@ var addon = require( './../src/addon.node' ); * * @example * var Complex128 = require( '@stdlib/complex/float64/ctor' ); -* var real = require( '@stdlib/complex/float64/real' ); -* var imag = require( '@stdlib/complex/float64/imag' ); * * var v = cceil( new Complex128( -1.5, 2.5 ) ); -* // returns -* -* var re = real( v ); -* // returns -1.0 -* -* var im = imag( v ); -* // returns 3.0 +* // returns [ -1.0, 3.0 ] */ function cceil( z ) { var v = addon( z );