From e04f5fb7123fc0bbcf5f6352a1494601c5cebd16 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 17 Sep 2024 14:02:18 +0000 Subject: [PATCH] Auto-generated commit --- CHANGELOG.md | 28 ++++++++++++++++++++++++- CONTRIBUTORS | 1 + base/accessor/README.md | 2 +- base/at/README.md | 2 +- base/at2d/README.md | 2 +- base/at3d/README.md | 2 +- base/at4d/README.md | 2 +- base/at5d/README.md | 2 +- base/atnd/README.md | 2 +- base/cuany/docs/types/test.ts | 1 - base/cuevery/docs/types/test.ts | 1 - base/cunone/docs/types/test.ts | 1 - base/cusome-by-right/README.md | 4 ++-- base/cusome-by-right/docs/types/test.ts | 2 -- 14 files changed, 37 insertions(+), 15 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a6cb440c..a5937d36 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -77,6 +77,28 @@ +
+ +#### [@stdlib/array/base/cunone-by](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/cunone-by) + +
+ +
+ +##### Features + +- [`24e9908`](https://github.com/stdlib-js/stdlib/commit/24e9908afc085d5d2aece1844a6e25b36332f246) - add `array/base/cunone-by` package + +
+ + + +
+ +
+ + +
#### [@stdlib/array/base/cunone-by-right](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/cunone-by-right) @@ -205,10 +227,11 @@ ### Contributors -A total of 4 people contributed to this release. Thank you to the following contributors: +A total of 5 people contributed to this release. Thank you to the following contributors: - Athan Reines - HarshaNP +- Kaif Mohd - Philipp Burckhardt - Vaibhav Patel @@ -222,10 +245,13 @@ A total of 4 people contributed to this release. Thank you to the following cont
+- [`f387603`](https://github.com/stdlib-js/stdlib/commit/f387603e739f88a38af3263ce6ff675ad903ee8c) - **docs:** consistently use declarative instead of imperative sentences outside of intros _(by Philipp Burckhardt)_ +- [`31fd427`](https://github.com/stdlib-js/stdlib/commit/31fd42744ec5d7073041f97c6f72350b8005c0fc) - **style:** remove unwanted empty lines _(by Philipp Burckhardt)_ - [`16bb447`](https://github.com/stdlib-js/stdlib/commit/16bb44733defec3009d7c49cbd8cb6eaaaa60ad2) - **fix:** update TypeScript function signature and documentation _(by Philipp Burckhardt)_ - [`0bb460f`](https://github.com/stdlib-js/stdlib/commit/0bb460f9675f693bd4eb5826888e493cae8757fc) - **feat:** add `array/base/cusome-by-right` _(by HarshaNP, Philipp Burckhardt)_ - [`cadb613`](https://github.com/stdlib-js/stdlib/commit/cadb6131d6ce50338d11757e88e8a910a0367983) - **chore:** update argument documentation styling _(by Philipp Burckhardt)_ - [`e722c97`](https://github.com/stdlib-js/stdlib/commit/e722c9742d30f0e3c0ec6ebb349b30338facbdf0) - **feat:** add `array/base/cunone-by-right` _(by HarshaNP, Philipp Burckhardt)_ +- [`24e9908`](https://github.com/stdlib-js/stdlib/commit/24e9908afc085d5d2aece1844a6e25b36332f246) - **feat:** add `array/base/cunone-by` package _(by Kaif Mohd, Philipp Burckhardt, Athan Reines)_ - [`a541897`](https://github.com/stdlib-js/stdlib/commit/a541897dec2cd902c186d9ad128b6efd8a3ca528) - **docs:** fix grammar _(by Athan Reines)_ - [`583452c`](https://github.com/stdlib-js/stdlib/commit/583452c820523f4bc97b293b4424d0c1bf59fffc) - **fix:** add missing property _(by Athan Reines)_ - [`91ad072`](https://github.com/stdlib-js/stdlib/commit/91ad07207eee217885975ce19d83e85d1f4a6499) - **fix:** add missing property _(by Athan Reines)_ diff --git a/CONTRIBUTORS b/CONTRIBUTORS index ecfde1e2..147a89ef 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -40,6 +40,7 @@ Joey Reed Jordan Gallivan <115050475+Jordan-Gallivan@users.noreply.github.com> Joris Labie Justin Dennison +Kaif Mohd Karthik Prakash <116057817+skoriop@users.noreply.github.com> Khaldon Krishnendu Das <86651039+itskdhere@users.noreply.github.com> diff --git a/base/accessor/README.md b/base/accessor/README.md index 155d6355..d42557ef 100644 --- a/base/accessor/README.md +++ b/base/accessor/README.md @@ -91,7 +91,7 @@ var v = arr.get( 0 ); #### AccessorArray.prototype.set( v\[, i] ) -Set an array element. +Sets an array element. ```javascript var arr = new AccessorArray( [ 1, 2, 3 ] ); diff --git a/base/at/README.md b/base/at/README.md index d1c2f5c2..7f89c3c0 100644 --- a/base/at/README.md +++ b/base/at/README.md @@ -42,7 +42,7 @@ var at = require( '@stdlib/array/base/at' ); #### at( x, index ) -Return an element from an array. +Returns an element from an array. ```javascript var x = [ 1, 2, 3, 4 ]; diff --git a/base/at2d/README.md b/base/at2d/README.md index b3d2ea87..6ced92e9 100644 --- a/base/at2d/README.md +++ b/base/at2d/README.md @@ -42,7 +42,7 @@ var at2d = require( '@stdlib/array/base/at2d' ); #### at2d( x, i0, i1 ) -Return an element from a two-dimensional nested array. +Returns an element from a two-dimensional nested array. ```javascript var x = [ [ 1, 2 ], [ 3, 4 ] ]; diff --git a/base/at3d/README.md b/base/at3d/README.md index ea7da8a8..a883f54b 100644 --- a/base/at3d/README.md +++ b/base/at3d/README.md @@ -42,7 +42,7 @@ var at3d = require( '@stdlib/array/base/at3d' ); #### at3d( x, i0, i1, i2 ) -Return an element from a three-dimensional nested array. +Returns an element from a three-dimensional nested array. ```javascript var x = [ [ [ 1, 2 ], [ 3, 4 ] ] ]; diff --git a/base/at4d/README.md b/base/at4d/README.md index a1cdb336..6e72bd42 100644 --- a/base/at4d/README.md +++ b/base/at4d/README.md @@ -42,7 +42,7 @@ var at4d = require( '@stdlib/array/base/at4d' ); #### at4d( x, i0, i1, i2, i3 ) -Return an element from a four-dimensional nested array. +Returns an element from a four-dimensional nested array. ```javascript var x = [ [ [ [ 1, 2 ], [ 3, 4 ] ] ] ]; diff --git a/base/at5d/README.md b/base/at5d/README.md index 3d1bb3f6..4e45b6d0 100644 --- a/base/at5d/README.md +++ b/base/at5d/README.md @@ -42,7 +42,7 @@ var at5d = require( '@stdlib/array/base/at5d' ); #### at5d( x, i0, i1, i2, i3, i4 ) -Return an element from a five-dimensional nested array. +Returns an element from a five-dimensional nested array. ```javascript var x = [ [ [ [ [ 1, 2 ], [ 3, 4 ] ] ] ] ]; diff --git a/base/atnd/README.md b/base/atnd/README.md index 0503d287..dd02cc81 100644 --- a/base/atnd/README.md +++ b/base/atnd/README.md @@ -42,7 +42,7 @@ var atnd = require( '@stdlib/array/base/atnd' ); #### atnd( x, i0\[, ...indices] ) -Return an element from an n-dimensional nested array. +Returns an element from an n-dimensional nested array. ```javascript var x = [ [ 1, 2 ], [ 3, 4 ] ]; diff --git a/base/cuany/docs/types/test.ts b/base/cuany/docs/types/test.ts index dc338cb9..7faad7c2 100644 --- a/base/cuany/docs/types/test.ts +++ b/base/cuany/docs/types/test.ts @@ -76,7 +76,6 @@ import cuany = require( './index' ); cuany.assign( x, {}, 2, 0 ); // $ExpectError } - // The compiler throws an error if the `assign` method is provided a third argument which is not a number... { const x = [ false, false, true, false, false ]; diff --git a/base/cuevery/docs/types/test.ts b/base/cuevery/docs/types/test.ts index 30224d35..8fa67c98 100644 --- a/base/cuevery/docs/types/test.ts +++ b/base/cuevery/docs/types/test.ts @@ -76,7 +76,6 @@ import cuevery = require( './index' ); cuevery.assign( x, {}, 2, 0 ); // $ExpectError } - // The compiler throws an error if the `assign` method is provided a third argument which is not a number... { const x = [ false, false, true, false, false ]; diff --git a/base/cunone/docs/types/test.ts b/base/cunone/docs/types/test.ts index 9ef3e9e5..44dfde5e 100644 --- a/base/cunone/docs/types/test.ts +++ b/base/cunone/docs/types/test.ts @@ -76,7 +76,6 @@ import cunone = require( './index' ); cunone.assign( x, {}, 2, 0 ); // $ExpectError } - // The compiler throws an error if the `assign` method is provided a third argument which is not a number... { const x = [ false, false, true, false, false ]; diff --git a/base/cusome-by-right/README.md b/base/cusome-by-right/README.md index dc543cf6..4a19d7df 100644 --- a/base/cusome-by-right/README.md +++ b/base/cusome-by-right/README.md @@ -32,7 +32,7 @@ var cusomeByRight = require( '@stdlib/array/base/cusome-by-right' ); #### cusomeByRight( x, n, predicate\[, thisArg ] ) -Cumulatively test whether at least `n` elements in a provided array pass a test implemented by a `predicate` function, while iterating from right-to-left. +Cumulatively tests whether at least `n` elements in a provided array pass a test implemented by a `predicate` function, while iterating from right-to-left. ```javascript function fcn( value ) { @@ -74,7 +74,7 @@ var count = context.count; #### cusomeByRight.assign( x, n, out, stride, offset, predicate\[, thisArg ] ) -Cumulatively test whether at least `n` elements in a provided array pass a test implemented by a `predicate` function, while iterating from right-to-left and assign the results to the elements in the output array. +Cumulatively tests whether at least `n` elements in a provided array pass a test implemented by a `predicate` function, while iterating from right-to-left and assign the results to the elements in the output array. ```javascript function fcn( v ) { diff --git a/base/cusome-by-right/docs/types/test.ts b/base/cusome-by-right/docs/types/test.ts index 160af937..9575a4ae 100644 --- a/base/cusome-by-right/docs/types/test.ts +++ b/base/cusome-by-right/docs/types/test.ts @@ -129,7 +129,6 @@ const isPositive = ( v: number ): boolean => { cusomeByRight.assign( x, [], y, 1, 0, isPositive ); // $ExpectError } - // The compiler throws an error if the `assign` method is provided a third argument which is not an array-like object... { const x = [ 1, 1, 0, 0, 0 ]; @@ -184,7 +183,6 @@ const isPositive = ( v: number ): boolean => { cusomeByRight.assign( x, 1, y, 1, 0, [] ); // $ExpectError } - // The compiler throws an error if the `assign` method is provided an unsupported number of arguments... { cusomeByRight.assign(); // $ExpectError