Auto-generated commit

stdlib-js · Nov 25, 2024 · 889cecf · 889cecf
1 parent a41b1cd
commit 889cecf
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -477,6 +477,10 @@ A total of 6 people contributed to this release. Thank you to the following cont
 
 <details>
 
+-   [`2af4b75`](https://github.com/stdlib-js/stdlib/commit/2af4b757cab1052ee7a788f2154f2c7b8c9aa9bb) - **docs:** add note _(by Athan Reines)_
+-   [`10641b6`](https://github.com/stdlib-js/stdlib/commit/10641b65eee7299d16d0c0239575eafc6b575557) - **docs:** add note _(by Athan Reines)_
+-   [`2c40c48`](https://github.com/stdlib-js/stdlib/commit/2c40c487c3f7cfcfa445d9855fb6c89b97ebf600) - **docs:** fix return values _(by Athan Reines)_
+-   [`dc93a3a`](https://github.com/stdlib-js/stdlib/commit/dc93a3ac7351a59e0f61e6384312d96655cc2edc) - **docs:** fix return values _(by Athan Reines)_
 -   [`b26d9d5`](https://github.com/stdlib-js/stdlib/commit/b26d9d5bd9e60a63ce017bbb470f0769b6dcc628) - **feat:** add `array/base/mskunary5d` [(#3207)](https://github.com/stdlib-js/stdlib/pull/3207) _(by Vinit Pandit, Athan Reines, Abhijit, stdlib-bot)_
 -   [`34ae5c9`](https://github.com/stdlib-js/stdlib/commit/34ae5c9570bf6428dc5bede92557ae56981554c2) - **feat:** add `array/base/mskbinary5d` [(#3198)](https://github.com/stdlib-js/stdlib/pull/3198) _(by Abhijit)_
 -   [`cb27ec4`](https://github.com/stdlib-js/stdlib/commit/cb27ec42bd7e65c46877e57064d36ff9b38b502b) - **feat:** add `array/base/mskbinary4d` [(#3196)](https://github.com/stdlib-js/stdlib/pull/3196) _(by Abhijit, Athan Reines)_

diff --git a/CONTRIBUTORS b/CONTRIBUTORS
@@ -3,6 +3,7 @@
 # Contributors listed in alphabetical order.
 
 Aayush Khanna <[email protected]>
+Abhijit <[email protected]>
 AbhijitRaut04 <[email protected]>
 Adarsh Palaskar <[email protected]>
 Aditya Sapra <[email protected]>
@@ -107,6 +108,7 @@ Utkarsh Raj <[email protected]>
 UtkershBasnet <[email protected]>
 Vaibhav Patel <[email protected]>
 Varad Gupta <[email protected]>
+Vinit Pandit <[email protected]>
 Xiaochuan Ye <[email protected]>
 Yernar Yergaziyev <[email protected]>
 naveen <[email protected]>

diff --git a/base/broadcasted-quaternary2d/docs/types/index.d.ts b/base/broadcasted-quaternary2d/docs/types/index.d.ts
@@ -109,7 +109,7 @@ type InOutShapes = [
 * bquaternary2d( [ x, y, z, w, out ], shapes, add );
 *
 * console.log( out );
-* // => [ [ 4.0, 8.0 ], [ 12.0, 16.0 ] ]
+* // => [ [ 4.0, 4.0 ], [ 4.0, 4.0 ] ]
 */
 declare function bquaternary2d<T = unknown, U = unknown, V = unknown, W = unknown, X = unknown>( arrays: InOutArrays<T, U, V, W, X>, shapes: InOutShapes, fcn: Quaternary<T, U, V, W, X> ): void;
 

diff --git a/base/broadcasted-ternary2d/docs/types/index.d.ts b/base/broadcasted-ternary2d/docs/types/index.d.ts
@@ -104,7 +104,7 @@ type InOutShapes = [
 * bternary2d( [ x, y, z, out ], shapes, add );
 *
 * console.log( out );
-* // => [ [ 3.0, 6.0 ], [ 9.0, 12.0 ] ]
+* // => [ [ 3.0, 3.0 ], [ 3.0, 3.0 ] ]
 */
 declare function bternary2d<T = unknown, U = unknown, V = unknown, W = unknown>( arrays: InOutArrays<T, U, V, W>, shapes: InOutShapes, fcn: Ternary<T, U, V, W> ): void;
 

diff --git a/base/mskbinary2d/README.md b/base/mskbinary2d/README.md
@@ -70,6 +70,7 @@ The function accepts the following arguments:
 ## Notes
 
 -   The function assumes that the input and output arrays have the same shape.
+-   An element in an input array is "masked" if the corresponding element in the mask array is non-zero.
 
 </section>
 

diff --git a/base/mskbinary3d/README.md b/base/mskbinary3d/README.md
@@ -76,6 +76,7 @@ The function accepts the following arguments:
 ## Notes
 
 -   The function assumes that the input and output arrays have the same shape.
+-   An element in an input array is "masked" if the corresponding element in the mask array is non-zero.
 
 </section>