From ea45cc4b9041aea8b23978214146d0052f0213c4 Mon Sep 17 00:00:00 2001 From: LokeshRanjan Date: Wed, 24 Dec 2025 16:02:02 +0530 Subject: [PATCH] docs: improve doctests for ndarray instances in `ndarray/concat1d --- 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: 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/ndarray/concat1d/README.md | 12 ++------ .../ndarray/concat1d/docs/types/index.d.ts | 30 ++++--------------- .../@stdlib/ndarray/concat1d/lib/assign.js | 5 +--- .../@stdlib/ndarray/concat1d/lib/index.js | 5 +--- .../@stdlib/ndarray/concat1d/lib/main.js | 5 +--- 5 files changed, 11 insertions(+), 46 deletions(-) diff --git a/lib/node_modules/@stdlib/ndarray/concat1d/README.md b/lib/node_modules/@stdlib/ndarray/concat1d/README.md index f0e77a1219fd..796b4adb0ed9 100644 --- a/lib/node_modules/@stdlib/ndarray/concat1d/README.md +++ b/lib/node_modules/@stdlib/ndarray/concat1d/README.md @@ -46,16 +46,12 @@ Returns a one-dimensional [ndarray][@stdlib/ndarray/ctor] formed by concatenatin ```javascript var array = require( '@stdlib/ndarray/array' ); -var ndarray2array = require( '@stdlib/ndarray/to-array' ); var x = array( [ -1.0, 2.0, 3.0, 4.0 ] ); var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] ); var out = concat1d( x, y ); -// returns - -var arr = ndarray2array( out ); -// returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] +// returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] ``` The function accepts the following arguments: @@ -71,20 +67,16 @@ Concatenates provided input arguments and assigns the result to a provided one-d ```javascript var array = require( '@stdlib/ndarray/array' ); var zeros = require( '@stdlib/ndarray/zeros' ); -var ndarray2array = require( '@stdlib/ndarray/to-array' ); var x = array( [ -1.0, 2.0, 3.0, 4.0 ] ); var y = array( [ -5.0, 6.0, -7.0, -8.0 ] ); var z = zeros( [ 8 ] ); var out = concat1d.assign( x, y, z ); -// returns +// returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0 ] var bool = ( out === z ); // returns true - -var arr = ndarray2array( z ); -// returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0 ] ``` The function accepts the following arguments: diff --git a/lib/node_modules/@stdlib/ndarray/concat1d/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/concat1d/docs/types/index.d.ts index b36050c2a86c..5679b8687711 100644 --- a/lib/node_modules/@stdlib/ndarray/concat1d/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/ndarray/concat1d/docs/types/index.d.ts @@ -46,10 +46,7 @@ interface Concat1d { * var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] ); * * var out = concat1d( x, y ); - * // returns - * - * var arr = ndarray2array( out ); - * // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] + * // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] */ ( arrays: Array> ): typedndarray; // FIXME: this is a tricky one to type correctly, as the actual output dtype depends on type promotion rules @@ -68,10 +65,7 @@ interface Concat1d { * var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] ); * * var out = concat1d( x, y ); - * // returns - * - * var arr = ndarray2array( out ); - * // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] + * // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] */ ( arg: Input, ...arrays: Array> ): typedndarray; // FIXME: this is a tricky one to type correctly, as the actual output dtype depends on type promotion rules @@ -92,13 +86,10 @@ interface Concat1d { * var z = empty( [ 10 ] ); * * var out = concat1d.assign( [ x, y ], z ); - * // returns + * // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] * * var bool = ( out === z ); * // returns true - * - * var arr = ndarray2array( z ); - * // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] */ assign = typedndarray>( args: ArrayLike>, out: V ): V; @@ -121,13 +112,10 @@ interface Concat1d { * var z = empty( [ 10 ] ); * * var out = concat1d.assign( x, y, z ); - * // returns + * // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] * * var bool = ( out === z ); * // returns true - * - * var arr = ndarray2array( z ); - * // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] */ assign = typedndarray>( arg1: Input, arg2: Input | V, ...args: Array | V> ): V; // FIXME: in order to more robustly return a correct output type here, we'd likely need to use overloads with varying arity. The issue here is that `V` needs to be the last argument, which is not captured here. } @@ -146,10 +134,7 @@ interface Concat1d { * var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] ); * * var out = concat1d( x, y ); -* // returns -* -* var arr = ndarray2array( out ); -* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] +* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] * * @example * var array = require( '@stdlib/ndarray/array' ); @@ -161,13 +146,10 @@ interface Concat1d { * var z = empty( [ 10 ] ); * * var out = concat1d.assign( [ x, y ], z ); -* // returns +* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] * * var bool = ( out === z ); * // returns true -* -* var arr = ndarray2array( z ); -* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] */ declare var concat1d: Concat1d; diff --git a/lib/node_modules/@stdlib/ndarray/concat1d/lib/assign.js b/lib/node_modules/@stdlib/ndarray/concat1d/lib/assign.js index 22e37cb7e356..f1721eea86de 100644 --- a/lib/node_modules/@stdlib/ndarray/concat1d/lib/assign.js +++ b/lib/node_modules/@stdlib/ndarray/concat1d/lib/assign.js @@ -60,13 +60,10 @@ var DEFAULT_DTYPE = defaults.get( 'dtypes.default' ); * var z = empty( [ 10 ] ); * * var out = assign( x, y, z ); -* // returns +* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] * * var bool = ( out === z ); * // returns true -* -* var arr = ndarray2array( z ); -* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] */ function assign() { var nargs; diff --git a/lib/node_modules/@stdlib/ndarray/concat1d/lib/index.js b/lib/node_modules/@stdlib/ndarray/concat1d/lib/index.js index 7bc8f7499ca6..1cb8c263871e 100644 --- a/lib/node_modules/@stdlib/ndarray/concat1d/lib/index.js +++ b/lib/node_modules/@stdlib/ndarray/concat1d/lib/index.js @@ -32,10 +32,7 @@ * var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] ); * * var out = concat1d( x, y ); -* // returns -* -* var arr = ndarray2array( out ); -* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] +* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/ndarray/concat1d/lib/main.js b/lib/node_modules/@stdlib/ndarray/concat1d/lib/main.js index f2f3a2318758..c62f5bc0ae8d 100644 --- a/lib/node_modules/@stdlib/ndarray/concat1d/lib/main.js +++ b/lib/node_modules/@stdlib/ndarray/concat1d/lib/main.js @@ -56,10 +56,7 @@ var DEFAULT_DTYPE = defaults.get( 'dtypes.default' ); * var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] ); * * var out = concat1d( x, y ); -* // returns -* -* var arr = ndarray2array( out ); -* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] +* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] */ function concat1d() { var nargs;