docs: fix TSDoc lint errors

stdlib-js · Sep 28, 2024 · ff9fa81 · ff9fa81
1 parent 975147f
commit ff9fa81
Show file tree

Hide file tree

Showing 13 changed files with 16 additions and 16 deletions.
diff --git a/lib/node_modules/@stdlib/assert/is-hex-string/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-hex-string/docs/types/index.d.ts
@@ -21,7 +21,7 @@
 /**
 * Tests whether a string contains only hexadecimal digits.
 *
-* @param x - value to test
+* @param value - value to test
 * @returns boolean indicating if a string contains only hexadecimal digits
 *
 * @example

diff --git a/lib/node_modules/@stdlib/strided/base/strided2object/docs/types/index.d.ts b/lib/node_modules/@stdlib/strided/base/strided2object/docs/types/index.d.ts
@@ -1218,7 +1218,7 @@ declare function strided2object<T = unknown>( N: number, x: Array<T>, stride: nu
 *     '2': 3,
 *     '4': 4,
 *     'length': 4
- };
+* };
 * var obj = strided2object( 4, x, 1, 0 );
 * // returns {...}
 *

diff --git a/lib/node_modules/@stdlib/strided/dispatch-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/strided/dispatch-by/docs/types/index.d.ts
@@ -786,7 +786,7 @@ interface Dispatcher {
 	* @param dtypeZ - data type for `z`
 	* @param z - strided array
 	* @param strideZ - index increment for `z`
-	* @param offsetZ = starting index for `z`
+	* @param offsetZ - starting index for `z`
 	* @param dtypeW - data type for `w`
 	* @param w - strided array
 	* @param strideW - index increment for `w`
@@ -912,7 +912,7 @@ interface Dispatcher {
 	* @param dtypeZ - data type for `z`
 	* @param z - strided array
 	* @param strideZ - index increment for `z`
-	* @param offsetZ = starting index for `z`
+	* @param offsetZ - starting index for `z`
 	* @param dtypeW - data type for `w`
 	* @param w - strided array
 	* @param strideW - index increment for `w`

diff --git a/lib/node_modules/@stdlib/string/to-grapheme-cluster-iterator-right/docs/types/index.d.ts b/lib/node_modules/@stdlib/string/to-grapheme-cluster-iterator-right/docs/types/index.d.ts
@@ -73,7 +73,7 @@ type MapFunction = Nullary | Unary | Binary | Ternary;
 * Returns an iterator which iterates from right to left over each grapheme cluster in a string.
 *
 * @param src - input value
-* @param mapFc - function to invoke for each iterated value
+* @param mapFcn - function to invoke for each iterated value
 * @param thisArg - execution context
 * @returns iterator
 *

diff --git a/lib/node_modules/@stdlib/string/to-grapheme-cluster-iterator/docs/types/index.d.ts b/lib/node_modules/@stdlib/string/to-grapheme-cluster-iterator/docs/types/index.d.ts
@@ -73,7 +73,7 @@ type MapFunction = Nullary | Unary | Binary | Ternary;
 * Returns an iterator which iterates over each grapheme cluster in a string.
 *
 * @param src - input value
-* @param mapFc - function to invoke for each iterated value
+* @param mapFcn - function to invoke for each iterated value
 * @param thisArg - execution context
 * @returns iterator
 *

diff --git a/lib/node_modules/@stdlib/utils/async/group-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/async/group-by/docs/types/index.d.ts
@@ -85,7 +85,7 @@ interface ValuesResults<T> {
 /**
 * Interface describing group results when returning indices.
 */
-interface IndicesResults<T> {
+interface IndicesResults {
 	/**
 	* Results for an individual group.
 	*/
@@ -128,7 +128,7 @@ type ValuesBinary<T> = ( error: Error | null, result: ValuesResults<T> ) => void
 * @param error - encountered error or null
 * @param result - group results
 */
-type IndicesBinary<T> = ( error: Error | null, result: IndicesResults<T> ) => void;
+type IndicesBinary<T> = ( error: Error | null, result: IndicesResults ) => void;
 
 /**
 * Callback invoked either upon processing all collection elements or upon encountering an error.

diff --git a/lib/node_modules/@stdlib/utils/bifurcate-in/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/bifurcate-in/docs/types/index.d.ts
@@ -128,7 +128,7 @@ declare function bifurcateIn( obj: any, predicate: Predicate ): Array<Array<any>
 *
 * -   Key iteration order is *not* guaranteed, and, thus, result order is *not* guaranteed.
 *
-* @param input object
+* @param obj - input object
 * @param options - function options
 * @param options.thisArg - execution context
 * @param options.returns - if `'values'`, values are returned; if `'keys'`, keys are returned; if `'*'`, both keys and values are returned (default: 'values')

diff --git a/lib/node_modules/@stdlib/utils/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/docs/types/index.d.ts
@@ -473,7 +473,7 @@ interface Namespace {
 	*
 	* -   Key iteration order is *not* guaranteed, and, thus, result order is *not* guaranteed.
 	*
-	* @param input object
+	* @param obj - input object
 	* @param options - function options
 	* @param options.thisArg - execution context
 	* @param options.returns - if `'values'`, values are returned; if `'keys'`, keys are returned; if `'*'`, both keys and values are returned (default: 'values')

diff --git a/lib/node_modules/@stdlib/utils/get-prototype-of/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/get-prototype-of/docs/types/index.d.ts
@@ -33,7 +33,7 @@
 * var proto = getPrototypeOf( {} );
 * // returns {}
 */
-declare function getPrototypeOf( v: any ): Object | null;
+declare function getPrototypeOf( value: any ): Object | null;
 
 
 // EXPORTS //

diff --git a/lib/node_modules/@stdlib/utils/object-inverse-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/object-inverse-by/docs/types/index.d.ts
@@ -152,7 +152,7 @@ declare function invertBy( obj: any, transform: Transform ): any;
 * var out = invertBy( obj, opts, transform );
 * // returns { 'beep': 'c', 'boop': 'b' }
 */
-declare function invertBy( obj: any, options: Options, transform: Transform ): any;
+declare function invertBy( obj: any, opts: Options, transform: Transform ): any;
 
 
 // EXPORTS //

diff --git a/lib/node_modules/@stdlib/utils/object-inverse/docs/types/index.d.ts b/lib/node_modules/@stdlib/utils/object-inverse/docs/types/index.d.ts
@@ -29,8 +29,8 @@ interface Options {
 * Inverts an object, such that keys become values and values become keys.
 *
 * @param obj - input object
-* @param opts - function options
-* @param opts.duplicates - boolean indicating whether to store duplicate keys (default: true)
+* @param options - function options
+* @param options.duplicates - boolean indicating whether to store duplicate keys (default: true)
 * @returns inverted object
 *
 * @example

diff --git a/lib/node_modules/@stdlib/wasm/base/arrays2ptrs/docs/types/index.d.ts b/lib/node_modules/@stdlib/wasm/base/arrays2ptrs/docs/types/index.d.ts
@@ -175,7 +175,7 @@ interface OutputArrayObject<T> extends InputArrayObject<T> {
 * var out = arrays2ptrs( ctx, [ xobj, yobj ] );
 * // returns [...]
 */
-declare function arrays2ptrs<T extends Collection | AccessorArrayLike<any>>( ctx: Context, arrays: ArrayLike<InputArrayObject<T>> ): Array<OutputArrayObject<T>>;
+declare function arrays2ptrs<T extends Collection | AccessorArrayLike<any>>( ctx: Context, list: ArrayLike<InputArrayObject<T>> ): Array<OutputArrayObject<T>>;
 
 
 // EXPORTS //

diff --git a/lib/node_modules/@stdlib/wasm/base/strided2object/docs/types/index.d.ts b/lib/node_modules/@stdlib/wasm/base/strided2object/docs/types/index.d.ts
@@ -1302,7 +1302,7 @@ declare function strided2object<T = unknown>( N: number, x: Array<T>, stride: nu
 *     '2': 3,
 *     '4': 4,
 *     'length': 4
- };
+* };
 * var obj = strided2object( 4, x, 1, 0 );
 * // returns {...}
 *