Skip to content

Commit 354a147

Browse files
committed
docs: add note
1 parent b916456 commit 354a147

File tree

1 file changed

+1
-0
lines changed
  • lib/node_modules/@stdlib/ndarray/filter

1 file changed

+1
-0
lines changed

lib/node_modules/@stdlib/ndarray/filter/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,7 @@ The `predicate` function is provided the following arguments:
128128
## Notes
129129

130130
- 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.
131+
- The function **always** returns a one-dimensional [ndarray][@stdlib/ndarray/ctor].
131132

132133
</section>
133134

0 commit comments

Comments
 (0)