From 975147f3125c786ec1672acb3d2564ca16eaa790 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sat, 28 Sep 2024 13:10:47 -0400 Subject: [PATCH] docs: fix TSDoc lint errors --- .../@stdlib/array/base/accessors/docs/types/index.d.ts | 2 +- .../@stdlib/array/base/arraylike2object/docs/types/index.d.ts | 2 +- .../@stdlib/array/base/filled/docs/types/index.d.ts | 2 +- .../@stdlib/array/filled-by/docs/types/index.d.ts | 4 ++-- lib/node_modules/@stdlib/array/logspace/docs/types/index.d.ts | 2 +- .../@stdlib/array/promotion-rules/docs/types/index.d.ts | 2 -- .../@stdlib/array/to-iterator/docs/types/index.d.ts | 2 +- .../@stdlib/blas/tools/swap-factory/docs/types/index.d.ts | 1 + .../@stdlib/complex/float64/docs/types/index.d.ts | 2 +- .../@stdlib/complex/float64/parse/docs/types/index.d.ts | 2 +- lib/node_modules/@stdlib/iter/cunone-by/docs/types/index.d.ts | 1 + .../base/nullary-loop-interchange-order/docs/types/index.d.ts | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) diff --git a/lib/node_modules/@stdlib/array/base/accessors/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/base/accessors/docs/types/index.d.ts index 36a099fabbdd..545692f4f3dc 100644 --- a/lib/node_modules/@stdlib/array/base/accessors/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/base/accessors/docs/types/index.d.ts @@ -874,7 +874,7 @@ declare function accessors( x: Array ): GenericAccessorObject * '2': 3, * '4': 4, * 'length': 4 - }; +* }; * var obj = accessors( x ); * // returns {...} * diff --git a/lib/node_modules/@stdlib/array/base/arraylike2object/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/base/arraylike2object/docs/types/index.d.ts index 1fef34467577..651e9d5c9512 100644 --- a/lib/node_modules/@stdlib/array/base/arraylike2object/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/base/arraylike2object/docs/types/index.d.ts @@ -1016,7 +1016,7 @@ declare function arraylike2object( x: Array ): GenericAccessorOb * '2': 3, * '4': 4, * 'length': 4 - }; +* }; * var obj = arraylike2object( x ); * // returns {...} * diff --git a/lib/node_modules/@stdlib/array/base/filled/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/base/filled/docs/types/index.d.ts index 6d5c928fd1e1..5940413946d5 100644 --- a/lib/node_modules/@stdlib/array/base/filled/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/base/filled/docs/types/index.d.ts @@ -21,7 +21,7 @@ /** * Returns a filled "generic" array. * -* @param value - fill value +* @param value - fill value, * @param len - array length * @returns output array * diff --git a/lib/node_modules/@stdlib/array/filled-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/filled-by/docs/types/index.d.ts index 333bf048e691..6c4b6f680ecf 100644 --- a/lib/node_modules/@stdlib/array/filled-by/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/filled-by/docs/types/index.d.ts @@ -151,7 +151,7 @@ declare function filledarrayBy( array: Collection, dtype: DataType, clbk: Callba * var arr = filledarrayBy( it, constantFunction( 1.0 ) ); * // returns [ 1.0, 1.0, 1.0 ] */ -declare function filledarrayBy( iterable: IterableIterator, callback: Callback, thisArg?: any ): ArrayOrTypedArray; // eslint-disable-line @typescript-eslint/unified-signatures +declare function filledarrayBy( iterable: IterableIterator, clbk: Callback, thisArg?: any ): ArrayOrTypedArray; // eslint-disable-line @typescript-eslint/unified-signatures /** * Creates a filled array from an iterable according to a callback function. @@ -172,7 +172,7 @@ declare function filledarrayBy( iterable: IterableIterator, callback: Callback, * var arr = filledarrayBy( it, 'float64', constantFunction( 1.0 ) ); * // returns [ 1.0, 1.0, 1.0 ] */ -declare function filledarrayBy( iterable: IterableIterator, dtype: DataType, callback: Callback, thisArg?: any ): ArrayOrTypedArray; // eslint-disable-line @typescript-eslint/unified-signatures +declare function filledarrayBy( iterable: IterableIterator, dtype: DataType, clbk: Callback, thisArg?: any ): ArrayOrTypedArray; // eslint-disable-line @typescript-eslint/unified-signatures /** * Returns a filled typed array view of an `ArrayBuffer` according to a provided callback function. diff --git a/lib/node_modules/@stdlib/array/logspace/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/logspace/docs/types/index.d.ts index 248d457ec91b..43c506c42e7c 100644 --- a/lib/node_modules/@stdlib/array/logspace/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/logspace/docs/types/index.d.ts @@ -31,7 +31,7 @@ * var arr = logspace( 0, 2, 6 ); * // returns [ 1, ~2.5, ~6.31, ~15.85, ~39.81, 100 ] */ -declare function logspace( x1: number, x2: number, len?: number ): Array; +declare function logspace( a: number, b: number, len?: number ): Array; // EXPORTS // diff --git a/lib/node_modules/@stdlib/array/promotion-rules/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/promotion-rules/docs/types/index.d.ts index b0e9da9834b4..56b987c8ffac 100644 --- a/lib/node_modules/@stdlib/array/promotion-rules/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/promotion-rules/docs/types/index.d.ts @@ -78,8 +78,6 @@ declare function promotionRules( dtype1: string, dtype2: string ): null; /** * Returns a type promotion table displaying array data types with the smallest size and closest "kind" to which array data types can be safely cast. * -* @param dtype1 - array data type -* @param dtype2 - array data type * @returns promotion rule table * * @example diff --git a/lib/node_modules/@stdlib/array/to-iterator/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/to-iterator/docs/types/index.d.ts index 703a5c52e121..d5e6f59c0d73 100644 --- a/lib/node_modules/@stdlib/array/to-iterator/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/to-iterator/docs/types/index.d.ts @@ -74,7 +74,7 @@ type MapFunction = Nullary | Unary | Binary | Ternary; * Returns an iterator which iterates over each element in an array-like object. * * @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/blas/tools/swap-factory/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/tools/swap-factory/docs/types/index.d.ts index f10de92b8e37..65f2f9d8190a 100644 --- a/lib/node_modules/@stdlib/blas/tools/swap-factory/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/tools/swap-factory/docs/types/index.d.ts @@ -61,6 +61,7 @@ type SwapFunction = ( x: ndarray, y: ndarray, dim?: number ) => ndarray; * * @param base - "base" function which interchanges two vectors * @param dtype - array data type +* @returns function wrapper * * @example * var Float64Array = require( '@stdlib/array/float64' ); diff --git a/lib/node_modules/@stdlib/complex/float64/docs/types/index.d.ts b/lib/node_modules/@stdlib/complex/float64/docs/types/index.d.ts index 67a3f27879ba..0fc0f15d3171 100644 --- a/lib/node_modules/@stdlib/complex/float64/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/complex/float64/docs/types/index.d.ts @@ -87,8 +87,8 @@ interface Namespace { * Parse a string representation of a 128-bit complex number. * * @param str - string representation of a complex number - * @returns Complex128 instance * @throws must provide a string recognized as a complex number + * @returns Complex128 instance * * @example * var str = '5 + 3i'; diff --git a/lib/node_modules/@stdlib/complex/float64/parse/docs/types/index.d.ts b/lib/node_modules/@stdlib/complex/float64/parse/docs/types/index.d.ts index 0458b0e9cfbf..bd822f506c84 100644 --- a/lib/node_modules/@stdlib/complex/float64/parse/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/complex/float64/parse/docs/types/index.d.ts @@ -29,8 +29,8 @@ import { Complex128 } from '@stdlib/types/complex'; * Parse a string representation of a 128-bit complex number. * * @param str - string representation of a complex number -* @returns Complex128 instance * @throws must provide a string recognized as a complex number +* @returns Complex128 instance * * @example * var str = '5 + 3i'; diff --git a/lib/node_modules/@stdlib/iter/cunone-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/iter/cunone-by/docs/types/index.d.ts index 75264e973848..300ac5534761 100644 --- a/lib/node_modules/@stdlib/iter/cunone-by/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/iter/cunone-by/docs/types/index.d.ts @@ -63,6 +63,7 @@ type Predicate = Nullary | Unary | Binary; * * @param iterator - source iterator * @param predicate - predicate function +* @param thisArg - execution context * @returns iterator * * @example diff --git a/lib/node_modules/@stdlib/ndarray/base/nullary-loop-interchange-order/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/base/nullary-loop-interchange-order/docs/types/index.d.ts index 67014262d151..f1145be16939 100644 --- a/lib/node_modules/@stdlib/ndarray/base/nullary-loop-interchange-order/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/ndarray/base/nullary-loop-interchange-order/docs/types/index.d.ts @@ -78,7 +78,7 @@ interface LoopOrderObject { * var idx = o.idx; * // returns [ 2, 1, 0 ] */ -declare function nullaryLoopOrder( shape: ArrayLike, stridesX: ArrayLike ): LoopOrderObject; +declare function nullaryLoopOrder( sh: ArrayLike, sx: ArrayLike ): LoopOrderObject; // EXPORTS //