docs: fix description

kgryte · kgryte · commit 694702469d8d · 2024-09-22T18:45:38.000-07:00
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
@@ -48,7 +48,7 @@ type BaseFunction<T> = ( N: number, x: T, strideX: number, offsetX: number, y: T
 *
 * @param x - first input array
 * @param y - second input array
-* @param dim - dimension for which to compute the dot product (default: -1)
+* @param dim - dimension along which to interchange vectors (default: -1)
 * @throws first argument must be a non-zero-dimensional ndarray
 * @throws second argument must be a non-zero-dimensional ndarray
 * @throws input arrays must have the same shape

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ type BaseFunction<T> = ( N: number, x: T, strideX: number, offsetX: number, y: T`
`48`	`48`	`*`
`49`	`49`	`* @param x - first input array`
`50`	`50`	`* @param y - second input array`
`51`		`-* @param dim - dimension for which to compute the dot product (default: -1)`
	`51`	`+* @param dim - dimension along which to interchange vectors (default: -1)`
`52`	`52`	`* @throws first argument must be a non-zero-dimensional ndarray`
`53`	`53`	`* @throws second argument must be a non-zero-dimensional ndarray`
`54`	`54`	`* @throws input arrays must have the same shape`