From 7db4645ab1d5946d04fe7ca6f640e367d4be0db3 Mon Sep 17 00:00:00 2001 From: Prajjwal Bajpai Date: Fri, 17 Apr 2026 22:25:40 +0530 Subject: [PATCH] docs: improve doctests for ndarray instances in `blas/ext/base/ndarray/dsorthp` --- 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/blas/ext/base/ndarray/dsorthp/README.md | 6 +----- .../@stdlib/blas/ext/base/ndarray/dsorthp/docs/repl.txt | 4 +--- .../blas/ext/base/ndarray/dsorthp/docs/types/index.d.ts | 6 +----- .../@stdlib/blas/ext/base/ndarray/dsorthp/lib/index.js | 6 +----- .../@stdlib/blas/ext/base/ndarray/dsorthp/lib/main.js | 6 +----- 5 files changed, 5 insertions(+), 23 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsorthp/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsorthp/README.md index 7351a4eb990e..5b7c8958f788 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsorthp/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsorthp/README.md @@ -43,7 +43,6 @@ Sorts a one-dimensional double-precision floating-point ndarray using heapsort. ```javascript var Float64Array = require( '@stdlib/array/float64' ); var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); -var ndarray2array = require( '@stdlib/ndarray/to-array' ); var ndarray = require( '@stdlib/ndarray/base/ctor' ); var xbuf = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] ); @@ -54,10 +53,7 @@ var order = scalar2ndarray( 1.0, { }); var out = dsorthp( [ x, order ] ); -// returns - -var arr = ndarray2array( out ); -// returns [ -4.0, -2.0, 1.0, 3.0 ] +// returns [ -4.0, -2.0, 1.0, 3.0 ] ``` The function has the following parameters: diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsorthp/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsorthp/docs/repl.txt index 92df0d63f567..8a0bdf9b407a 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsorthp/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsorthp/docs/repl.txt @@ -33,9 +33,7 @@ > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord ); > var o = {{alias:@stdlib/ndarray/from-scalar}}( 1.0, { 'dtype': dt } ); > {{alias}}( [ x, o ] ) - - > var data = x.data - [ -4.0, -2.0, 1.0, 3.0 ] + [ -4.0, -2.0, 1.0, 3.0 ] See Also -------- diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsorthp/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsorthp/docs/types/index.d.ts index 3b52c65f442a..d178d3449f21 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsorthp/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsorthp/docs/types/index.d.ts @@ -34,7 +34,6 @@ import { typedndarray, float64ndarray } from '@stdlib/types/ndarray'; * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * @@ -46,10 +45,7 @@ import { typedndarray, float64ndarray } from '@stdlib/types/ndarray'; * }); * * var out = dsorthp( [ x, ord ] ); -* // returns -* -* var arr = ndarray2array( out ); -* // returns [ -4.0, -2.0, 1.0, 3.0 ] +* // returns [ -4.0, -2.0, 1.0, 3.0 ] */ declare function dsorthp( arrays: [ float64ndarray, typedndarray ] ): float64ndarray; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsorthp/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsorthp/lib/index.js index 7322b72304eb..381b207a84d0 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsorthp/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsorthp/lib/index.js @@ -26,7 +26,6 @@ * @example * var Float64Array = require( '@stdlib/array/float64' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); * var dsorthp = require( '@stdlib/blas/ext/base/ndarray/dsorthp' ); * @@ -38,10 +37,7 @@ * }); * * var out = dsorthp( [ x, ord ] ); -* // returns -* -* var arr = ndarray2array( out ); -* // returns [ -4.0, -2.0, 1.0, 3.0 ] +* // returns [ -4.0, -2.0, 1.0, 3.0 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsorthp/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsorthp/lib/main.js index 0b8a1e8f893d..136940f01fd8 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsorthp/lib/main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dsorthp/lib/main.js @@ -42,7 +42,6 @@ var strided = require( '@stdlib/blas/ext/base/dsorthp' ).ndarray; * * @example * var Float64Array = require( '@stdlib/array/float64' ); -* var ndarray2array = require( '@stdlib/ndarray/to-array' ); * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * @@ -54,10 +53,7 @@ var strided = require( '@stdlib/blas/ext/base/dsorthp' ).ndarray; * }); * * var out = dsorthp( [ x, ord ] ); -* // returns -* -* var arr = ndarray2array( out ); -* // returns [ -4.0, -2.0, 1.0, 3.0 ] +* // returns [ -4.0, -2.0, 1.0, 3.0 ] */ function dsorthp( arrays ) { var ord;