docs: update descriptions and add notes

Signed-off-by: Athan <[email protected]>

Author: kgryte

lib/node_modules/@stdlib/blas/ext/find-index/docs/types/index.d.ts

@@ -35,15 +35,15 @@ type OutputArray = typedndarray<number>;
 /**
 * Returns a boolean indicating whether an element passes a test.
 *
-* @returns a boolean indicating whether an element passes a test
+* @returns boolean indicating whether an element passes a test
 */
 type NullaryPredicate<ThisArg> = ( this: ThisArg ) => boolean;
 
 /**
 * Returns a boolean indicating whether an element passes a test.
 *
 * @param value - current array element
-* @returns a boolean indicating whether an element passes a test
+* @returns boolean indicating whether an element passes a test
 */
 type UnaryPredicate<T, ThisArg> = ( this: ThisArg, value: T ) => boolean;
 
@@ -52,7 +52,7 @@ type UnaryPredicate<T, ThisArg> = ( this: ThisArg, value: T ) => boolean;
 *
 * @param value - current array element
 * @param index - current array element index
-* @returns a boolean indicating whether an element passes a test
+* @returns boolean indicating whether an element passes a test
 */
 type BinaryPredicate<T, ThisArg> = ( this: ThisArg, value: T, index: number ) => boolean;
 
@@ -62,7 +62,7 @@ type BinaryPredicate<T, ThisArg> = ( this: ThisArg, value: T, index: number ) =>
 * @param value - current array element
 * @param index - current array element index
 * @param array - input ndarray
-* @returns a boolean indicating whether an element passes a test
+* @returns boolean indicating whether an element passes a test
 */
 type TernaryPredicate<T, U, ThisArg> = ( this: ThisArg, value: T, index: number, array: U ) => boolean;
 
@@ -72,7 +72,7 @@ type TernaryPredicate<T, U, ThisArg> = ( this: ThisArg, value: T, index: number,
 * @param value - current array element
 * @param index - current array element index
 * @param array - input ndarray
-* @returns a boolean indicating whether an element passes a test
+* @returns boolean indicating whether an element passes a test
 */
 type Predicate<T, U, ThisArg> = NullaryPredicate<ThisArg> | UnaryPredicate<T, ThisArg> | BinaryPredicate<T, ThisArg> | TernaryPredicate<T, U, ThisArg>;
 
@@ -111,6 +111,10 @@ interface Options extends BaseOptions {
 interface FindIndex {
 	/**
 	* Returns the first index of an element along an ndarray dimension which passes a test implemented by a predicate function.
+ 	*
+  	* ## Notes
+	*
+ 	* -   If no element along an ndarray dimension passes a test implemented by the predicate function, the corresponding element in the returned ndarray is `-1`.
 	*
 	* @param x - input ndarray
 	* @param clbk - predicate function
@@ -137,6 +141,10 @@ interface FindIndex {
 	/**
 	* Returns the first index of an element along an ndarray dimension which passes a test implemented by a predicate function.
 	*
+	* ## Notes
+	*
+ 	* -   If no element along an ndarray dimension passes a test implemented by the predicate function, the corresponding element in the returned ndarray is `-1`.
+	*
 	* @param x - input ndarray
 	* @param options - function options
 	* @param clbk - predicate function
@@ -163,6 +171,10 @@ interface FindIndex {
 	/**
 	* Returns the first index of an element along an ndarray dimension which passes a test implemented by a predicate function and assigns results to a provided output ndarray.
 	*
+	* ## Notes
+	*
+ 	* -   If no element along an ndarray dimension passes a test implemented by the predicate function, the corresponding element in the returned ndarray is `-1`.
+	*
 	* @param x - input ndarray
 	* @param out - output ndarray
 	* @param clbk - predicate function
@@ -194,6 +206,10 @@ interface FindIndex {
 	/**
 	* Returns the first index of an element along an ndarray dimension which passes a test implemented by a predicate function and assigns results to a provided output ndarray.
 	*
+	* ## Notes
+	*
+ 	* -   If no element along an ndarray dimension passes a test implemented by the predicate function, the corresponding element in the returned ndarray is `-1`.
+	*
 	* @param x - input ndarray
 	* @param out - output ndarray
 	* @param options - function options
@@ -227,6 +243,10 @@ interface FindIndex {
 /**
 * Returns the first index of an element along an ndarray dimension which passes a test implemented by a predicate function and assigns results to a provided output ndarray.
 *
+* ## Notes
+*
+* -   If no element along an ndarray dimension passes a test implemented by the predicate function, the corresponding element in the returned ndarray is `-1`.
+*
 * @param x - input ndarray
 * @param options - function options
 * @param clbk - predicate function