Skip to content

Commit baf1b99

Browse files
authored
docs: add note
Signed-off-by: Athan <[email protected]>
1 parent f1356e2 commit baf1b99

File tree

1 file changed

+4
-0
lines changed
  • lib/node_modules/@stdlib/blas/ext/base/ndarray/gfind-index/docs/types

1 file changed

+4
-0
lines changed

lib/node_modules/@stdlib/blas/ext/base/ndarray/gfind-index/docs/types/index.d.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,10 @@ type Predicate<T, U, ThisArg> = Nullary<ThisArg> | Unary<T, ThisArg> | Binary<T,
6969
/**
7070
* Returns the index of the first element in a one-dimensional ndarray which passes a test implemented by a predicate function.
7171
*
72+
* ## Notes
73+
*
74+
* - If no element passes a test implemented by a predicate function, the function returns `-1`.
75+
*
7276
* @param arrays - array-like object containing an input ndarray
7377
* @param clbk - predicate function
7478
* @param thisArg - predicate function execution context

0 commit comments

Comments
 (0)