From 2814e395383420256abcaa3e73e3c731df225dfe Mon Sep 17 00:00:00 2001 From: Mahi Date: Sat, 31 Jan 2026 00:06:20 +0530 Subject: [PATCH 1/7] tools/snippets: add documentation and basic tests for placeholder snippet function --- tools/snippets/lib/index.js | 32 +++++++------------------------- tools/snippets/lib/main.js | 37 +++++++++++-------------------------- tools/snippets/test/test.js | 28 ++++++---------------------- 3 files changed, 24 insertions(+), 73 deletions(-) diff --git a/tools/snippets/lib/index.js b/tools/snippets/lib/index.js index 5ec20be28792..83fc0b376ff7 100644 --- a/tools/snippets/lib/index.js +++ b/tools/snippets/lib/index.js @@ -1,40 +1,22 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - 'use strict'; /** -* TODO: description +* Example snippet utility. * -* @module @stdlib/ +* @module @stdlib/tools/snippets * * @example -* var TODO = require( '@stdlib/' ); +* var snippet = require( '@stdlib/tools/snippets' ); * -* var v = TODO( 0.0 ); -* // returns TODO +* var v = snippet( 3.0 ); +* // returns 3.0 */ // MODULES // -var TODO = require( './main.js' ); +var snippet = require( './main.js' ); // EXPORTS // -module.exports = TODO; +module.exports = snippet; diff --git a/tools/snippets/lib/main.js b/tools/snippets/lib/main.js index c9409542e1e4..49d1ff3748aa 100644 --- a/tools/snippets/lib/main.js +++ b/tools/snippets/lib/main.js @@ -1,40 +1,25 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - 'use strict'; // MAIN // /** -* TODO: description +* Example snippet function which returns the input value unchanged. +* +* This function exists as a simple demonstration utility for tooling +* and documentation examples. * -* @param {} TODO - TODO: param desc -* @returns {} TODO: desc +* @param {number} x - input value +* @returns {number} input value * * @example -* var v = TODO( 0.0 ); -* // returns TODO +* var v = snippet( 2.0 ); +* // returns 2.0 */ -function TODO() { - // TODO: implementation +function snippet( x ) { + return x; } // EXPORTS // -module.exports = TODO; +module.exports = snippet; diff --git a/tools/snippets/test/test.js b/tools/snippets/test/test.js index 5fc8f28d2b0c..596c55d75288 100644 --- a/tools/snippets/test/test.js +++ b/tools/snippets/test/test.js @@ -1,35 +1,19 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - 'use strict'; // MODULES // var tape = require( 'tape' ); -var TODO = require( './../lib' ); +var snippet = require( './../lib' ); // TESTS // tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof TODO, 'function', 'main export is a function' ); + t.strictEqual( typeof snippet, 'function', 'exports a function' ); t.end(); }); -// TODO: add tests +tape( 'returns input value unchanged', function test( t ) { + t.strictEqual( snippet( 4.0 ), 4.0, 'returns same value' ); + t.end(); +}); From 5465f9cc5e40e0d3d270f6e920bb20c49f2e3f7c Mon Sep 17 00:00:00 2001 From: Mahi Date: Sun, 1 Feb 2026 12:41:12 +0530 Subject: [PATCH 2/7] docs: fix broken Schubert & Gertz DOI link --- .../@stdlib/stats/base/ndarray/variancech/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/variancech/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/variancech/README.md index d90560491b64..d767408e20f0 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/variancech/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/variancech/README.md @@ -199,7 +199,7 @@ console.log( v ); [@chan:1983a]: https://doi.org/10.1080/00031305.1983.10483115 -[@schubert:2018a]: https://doi.org/10.1145/3221664.3221674 +[@schubert:2018a]: https://dl.acm.org/doi/10.1145/3221664.3221674 From 09789d8a0e45b4e4bb60a6b703ba62c5c26f84fc Mon Sep 17 00:00:00 2001 From: Mahi Date: Sun, 1 Feb 2026 13:12:25 +0530 Subject: [PATCH 3/7] chore: fix JavaScript lint errors (issue #10017) --- .../@stdlib/stats/strided/mskmidrange/benchmark/benchmark.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/strided/mskmidrange/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/strided/mskmidrange/benchmark/benchmark.js index c612172c08e0..1b436fba19cc 100644 --- a/lib/node_modules/@stdlib/stats/strided/mskmidrange/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/strided/mskmidrange/benchmark/benchmark.js @@ -27,7 +27,7 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var format = require( '@stdlib/string/format' ); var pkg = require( './../package.json' ).name; -var mskmidrange = require( './../lib/mskmidrange.js' ); +var mskmidrange = require( './../lib/index.js' ); // VARIABLES // From 331a9546603f1bd9ead2710534d56b8e9c58986a Mon Sep 17 00:00:00 2001 From: Athan Date: Sun, 1 Feb 2026 18:08:36 -0800 Subject: [PATCH 4/7] Discard changes to tools/snippets/lib/index.js --- tools/snippets/lib/index.js | 32 +++++++++++++++++++++++++------- 1 file changed, 25 insertions(+), 7 deletions(-) diff --git a/tools/snippets/lib/index.js b/tools/snippets/lib/index.js index 83fc0b376ff7..5ec20be28792 100644 --- a/tools/snippets/lib/index.js +++ b/tools/snippets/lib/index.js @@ -1,22 +1,40 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + 'use strict'; /** -* Example snippet utility. +* TODO: description * -* @module @stdlib/tools/snippets +* @module @stdlib/ * * @example -* var snippet = require( '@stdlib/tools/snippets' ); +* var TODO = require( '@stdlib/' ); * -* var v = snippet( 3.0 ); -* // returns 3.0 +* var v = TODO( 0.0 ); +* // returns TODO */ // MODULES // -var snippet = require( './main.js' ); +var TODO = require( './main.js' ); // EXPORTS // -module.exports = snippet; +module.exports = TODO; From 8e7721bc384d993fb570198b10f36119e4322bc5 Mon Sep 17 00:00:00 2001 From: Athan Date: Sun, 1 Feb 2026 18:08:43 -0800 Subject: [PATCH 5/7] Discard changes to tools/snippets/lib/main.js --- tools/snippets/lib/main.js | 37 ++++++++++++++++++++++++++----------- 1 file changed, 26 insertions(+), 11 deletions(-) diff --git a/tools/snippets/lib/main.js b/tools/snippets/lib/main.js index 49d1ff3748aa..c9409542e1e4 100644 --- a/tools/snippets/lib/main.js +++ b/tools/snippets/lib/main.js @@ -1,25 +1,40 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + 'use strict'; // MAIN // /** -* Example snippet function which returns the input value unchanged. -* -* This function exists as a simple demonstration utility for tooling -* and documentation examples. +* TODO: description * -* @param {number} x - input value -* @returns {number} input value +* @param {} TODO - TODO: param desc +* @returns {} TODO: desc * * @example -* var v = snippet( 2.0 ); -* // returns 2.0 +* var v = TODO( 0.0 ); +* // returns TODO */ -function snippet( x ) { - return x; +function TODO() { + // TODO: implementation } // EXPORTS // -module.exports = snippet; +module.exports = TODO; From 87241a5fefd512dad47317803ebc4fe4913e9e62 Mon Sep 17 00:00:00 2001 From: Athan Date: Sun, 1 Feb 2026 18:08:49 -0800 Subject: [PATCH 6/7] Discard changes to tools/snippets/test/test.js --- tools/snippets/test/test.js | 28 ++++++++++++++++++++++------ 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/tools/snippets/test/test.js b/tools/snippets/test/test.js index 596c55d75288..5fc8f28d2b0c 100644 --- a/tools/snippets/test/test.js +++ b/tools/snippets/test/test.js @@ -1,19 +1,35 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + 'use strict'; // MODULES // var tape = require( 'tape' ); -var snippet = require( './../lib' ); +var TODO = require( './../lib' ); // TESTS // tape( 'main export is a function', function test( t ) { - t.strictEqual( typeof snippet, 'function', 'exports a function' ); + t.ok( true, __filename ); + t.strictEqual( typeof TODO, 'function', 'main export is a function' ); t.end(); }); -tape( 'returns input value unchanged', function test( t ) { - t.strictEqual( snippet( 4.0 ), 4.0, 'returns same value' ); - t.end(); -}); +// TODO: add tests From d248afd0dc1384b7b4ec47c93b869d3afcd01995 Mon Sep 17 00:00:00 2001 From: d-mahi14 Date: Mon, 2 Feb 2026 10:08:11 +0530 Subject: [PATCH 7/7] Revert unrelated README change MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This PR is intended to address JavaScript lint errors related to issue #10017 only. I’ve reverted unrelated documentation changes and kept the scope limited to eslint fixes. Thanks for the review. Signed-off-by: d-mahi14 --- .../@stdlib/stats/base/ndarray/variancech/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/variancech/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/variancech/README.md index d767408e20f0..d90560491b64 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/variancech/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/variancech/README.md @@ -199,7 +199,7 @@ console.log( v ); [@chan:1983a]: https://doi.org/10.1080/00031305.1983.10483115 -[@schubert:2018a]: https://dl.acm.org/doi/10.1145/3221664.3221674 +[@schubert:2018a]: https://doi.org/10.1145/3221664.3221674