From 5abe60c72b2fc7a0561b73fc52b7a257128d1cf7 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 14 Dec 2024 05:08:30 +0000 Subject: [PATCH] Auto-generated commit --- CHANGELOG.md | 1 + README.md | 1 + 2 files changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 81a11b0..0febb3c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,6 +22,7 @@
+- [`354a147`](https://github.com/stdlib-js/stdlib/commit/354a1472bd69ab26c020aa7ba1df043c88e985b2) - **docs:** add note _(by Athan Reines)_ - [`80542fd`](https://github.com/stdlib-js/stdlib/commit/80542fd459075dc2c49f6e529a21bd661129899e) - **docs:** remove note _(by Athan Reines)_ - [`d481f26`](https://github.com/stdlib-js/stdlib/commit/d481f264f68deee3497bf73480c2c88efc3a725f) - **feat:** add `ndarray/filter` _(by Athan Reines)_ diff --git a/README.md b/README.md index 684a2b3..914d1f3 100644 --- a/README.md +++ b/README.md @@ -161,6 +161,7 @@ The `predicate` function is provided the following arguments: ## Notes - The function does **not** perform explicit casting (e.g., from a real-valued floating-point number to a complex floating-point number). Any such casting should be performed **prior to** calling this function. +- The function **always** returns a one-dimensional [ndarray][@stdlib/ndarray/ctor].