Auto-generated commit

stdlib-js · Sep 28, 2024 · b9df707 · b9df707
1 parent 67597b4
commit b9df707
Show file tree

Hide file tree

Showing 17 changed files with 33 additions and 29 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -321,6 +321,7 @@ A total of 3 people contributed to this release. Thank you to the following cont
 
 <details>
 
+-   [`abf0407`](https://github.com/stdlib-js/stdlib/commit/abf040787f6598438b0100a729a8331b7f80f62f) - **chore:** resolve lint errors in TS files _(by Philipp Burckhardt)_
 -   [`7f368f6`](https://github.com/stdlib-js/stdlib/commit/7f368f6c3f4cea444a304a62616cea36a5f143eb) - **fix:** remove unused imports from TS declaration file _(by Philipp Burckhardt)_
 -   [`975147f`](https://github.com/stdlib-js/stdlib/commit/975147f3125c786ec1672acb3d2564ca16eaa790) - **docs:** fix TSDoc lint errors _(by Philipp Burckhardt)_
 -   [`8f72b43`](https://github.com/stdlib-js/stdlib/commit/8f72b432c0fc81a78641d5689722ecc9671c6f02) - **style:** add missing spaces around parentheses _(by Philipp Burckhardt)_

diff --git a/base/broadcast-array/docs/types/test.ts b/base/broadcast-array/docs/types/test.ts
@@ -24,7 +24,7 @@ import broadcastArray = require( './index' );
 /**
 * Mock function to create an ndarray-like object.
 *
-* @return ndarray-like object
+* @returns ndarray-like object
 */
 function array(): ndarray {
 	const obj: ndarray = {

diff --git a/base/for-each/docs/types/test.ts b/base/for-each/docs/types/test.ts
@@ -24,7 +24,7 @@ import forEach = require( './index' );
 /**
 * Mock function to create an ndarray-like object.
 *
-* @return ndarray-like object
+* @returns ndarray-like object
 */
 function array(): ndarray {
 	const obj: ndarray = {
@@ -50,6 +50,9 @@ function array(): ndarray {
 
 /**
 * Callback function.
+*
+* @param v - ndarray element
+* @throws unexpected error
 */
 function clbk( v: any ): void {
 	if ( v !== v ) {

diff --git a/base/map/docs/types/test.ts b/base/map/docs/types/test.ts
@@ -24,7 +24,7 @@ import map = require( './index' );
 /**
 * Mock function to create an ndarray-like object.
 *
-* @return ndarray-like object
+* @returns ndarray-like object
 */
 function array(): ndarray {
 	const obj: ndarray = {

diff --git a/base/maybe-broadcast-array/docs/types/test.ts b/base/maybe-broadcast-array/docs/types/test.ts
@@ -24,7 +24,7 @@ import maybeBroadcastArray = require( './index' );
 /**
 * Mock function to create an ndarray-like object.
 *
-* @return ndarray-like object
+* @returns ndarray-like object
 */
 function array(): ndarray {
 	const obj: ndarray = {

diff --git a/base/ndarraylike2ndarray/docs/types/test.ts b/base/ndarraylike2ndarray/docs/types/test.ts
@@ -24,7 +24,7 @@ import ndarraylike2ndarray = require( './index' );
 /**
 * Mock function to create an ndarray-like object.
 *
-* @return ndarray-like object
+* @returns ndarray-like object
 */
 function array(): typedndarray<number> {
 	const obj: typedndarray<number> = {

diff --git a/base/ndarraylike2object/docs/types/test.ts b/base/ndarraylike2object/docs/types/test.ts
@@ -24,7 +24,7 @@ import ndarraylike2object = require( './index' );
 /**
 * Mock function to create an ndarray-like object.
 *
-* @return ndarray-like object
+* @returns ndarray-like object
 */
 function array(): ndarray {
 	const obj: ndarray = {

diff --git a/base/nullary/docs/types/test.ts b/base/nullary/docs/types/test.ts
@@ -24,7 +24,7 @@ import nullary = require( './index' );
 /**
 * Mock function to create an ndarray-like object.
 *
-* @return ndarray-like object
+* @returns ndarray-like object
 */
 function array(): ndarray {
 	const obj: ndarray = {

diff --git a/base/serialize-meta-data/docs/types/test.ts b/base/serialize-meta-data/docs/types/test.ts
@@ -24,7 +24,7 @@ import serialize = require( './index' );
 /**
 * Mock function to create an ndarray-like object.
 *
-* @return ndarray-like object
+* @returns ndarray-like object
 */
 function array(): ndarray {
 	const obj: ndarray = {

diff --git a/base/unary-by/docs/types/test.ts b/base/unary-by/docs/types/test.ts
@@ -24,7 +24,7 @@ import unaryBy = require( './index' );
 /**
 * Mock function to create an ndarray-like object.
 *
-* @return ndarray-like object
+* @returns ndarray-like object
 */
 function array(): ndarray {
 	const obj: ndarray = {

diff --git a/base/unary/docs/types/test.ts b/base/unary/docs/types/test.ts
@@ -24,7 +24,7 @@ import unary = require( './index' );
 /**
 * Mock function to create an ndarray-like object.
 *
-* @return ndarray-like object
+* @returns ndarray-like object
 */
 function array(): ndarray {
 	const obj: ndarray = {

diff --git a/dispatch/docs/types/test.ts b/dispatch/docs/types/test.ts
@@ -30,7 +30,7 @@ import dispatch = require( './index' );
 /**
 * Nullary callback.
 *
-* @return input value
+* @returns input value
 */
 function nullary(): any {
 	return 5.0;
@@ -40,7 +40,7 @@ function nullary(): any {
 * Unary callback.
 *
 * @param x - input value
-* @return input value
+* @returns input value
 */
 function unary( x: any ): any {
 	return x;
@@ -51,7 +51,7 @@ function unary( x: any ): any {
 *
 * @param x - input value
 * @param y - input value
-* @return output value
+* @returns output value
 */
 function binary( x: number, y: number ): number {
 	return x + y;
@@ -63,7 +63,7 @@ function binary( x: number, y: number ): number {
 * @param x - input value
 * @param y - input value
 * @param z - input value
-* @return output value
+* @returns output value
 */
 function ternary( x: number, y: number, z: number ): number {
 	return x + y + z;
@@ -76,7 +76,7 @@ function ternary( x: number, y: number, z: number ): number {
 * @param y - input value
 * @param z - input value
 * @param w - input value
-* @return output value
+* @returns output value
 */
 function quaternary( x: number, y: number, z: number, w: number ): number {
 	return x + y + z + w;
@@ -88,7 +88,7 @@ function quaternary( x: number, y: number, z: number, w: number ): number {
 * @param shape - dimensions
 * @param idx - linear index
 * @param opts - options
-* @return subscripts
+* @returns subscripts
 */
 function ind2sub( shape: ArrayLike<number>, idx: number, opts?: any ): Array<number> {
 	let out;
@@ -164,7 +164,7 @@ function ndarrayFcn( arrays: Array<ndarray>, fcn: ( x: any ) => any ): void {
 /**
 * Mock function to create an ndarray-like object.
 *
-* @return ndarray-like object
+* @returns ndarray-like object
 */
 function array(): ndarray {
 	const obj: ndarray = {

diff --git a/ind2sub/docs/types/test.ts b/ind2sub/docs/types/test.ts
@@ -157,7 +157,7 @@ import ind2sub = require( './index' );
 	const opts = {
 		'order': 'row-major'
 	};
-	ind2sub.assign( shape, true opts, out ); // $ExpectError
+	ind2sub.assign( shape, true, opts, out ); // $ExpectError
 	ind2sub.assign( shape, false opts, out ); // $ExpectError
 	ind2sub.assign( shape, null opts, out ); // $ExpectError
 	ind2sub.assign( shape, undefined opts, out ); // $ExpectError

diff --git a/ndarraylike2ndarray/docs/types/test.ts b/ndarraylike2ndarray/docs/types/test.ts
@@ -24,7 +24,7 @@ import ndarraylike2ndarray = require( './index' );
 /**
 * Mock function to create an ndarray-like object.
 *
-* @return ndarray-like object
+* @returns ndarray-like object
 */
 function array(): typedndarray<number> {
 	const obj: typedndarray<number> = {

diff --git a/slice-dimension-from/docs/types/test.ts b/slice-dimension-from/docs/types/test.ts
@@ -125,7 +125,7 @@ import sliceDimensionFrom = require( './index' );
 	sliceDimensionFrom( x, 1, {} ); // $ExpectError
 	sliceDimensionFrom( x, 1, ( x: number ): number => x, 1 ); // $ExpectError
 
-	sliceDimensionFrom( x, 1, '5', {}; // $ExpectError
+	sliceDimensionFrom( x, 1, '5', {} ); // $ExpectError
 	sliceDimensionFrom( x, 1, false, {}; // $ExpectError
 	sliceDimensionFrom( x, 1, true, {}; // $ExpectError
 	sliceDimensionFrom( x, 1, null, {}; // $ExpectError

diff --git a/slice-dimension-to/docs/types/test.ts b/slice-dimension-to/docs/types/test.ts
@@ -125,14 +125,14 @@ import sliceDimensionTo = require( './index' );
 	sliceDimensionTo( x, 1, {} ); // $ExpectError
 	sliceDimensionTo( x, 1, ( x: number ): number => x, 1 ); // $ExpectError
 
-	sliceDimensionTo( x, 1, '5', {}; // $ExpectError
-	sliceDimensionTo( x, 1, false, {}; // $ExpectError
-	sliceDimensionTo( x, 1, true, {}; // $ExpectError
-	sliceDimensionTo( x, 1, null, {}; // $ExpectError
-	sliceDimensionTo( x, 1, undefined, {}; // $ExpectError
-	sliceDimensionTo( x, 1, [ '5' ], {}; // $ExpectError
-	sliceDimensionTo( x, 1, {}, {}; // $ExpectError
-	sliceDimensionTo( x, 1, ( x: number ): number => x, {}; // $ExpectError
+	sliceDimensionTo( x, 1, '5', {} ); // $ExpectError
+	sliceDimensionTo( x, 1, false, {} ); // $ExpectError
+	sliceDimensionTo( x, 1, true, {} ); // $ExpectError
+	sliceDimensionTo( x, 1, null, {} ); // $ExpectError
+	sliceDimensionTo( x, 1, undefined, {} ); // $ExpectError
+	sliceDimensionTo( x, 1, [ '5' ], {} ); // $ExpectError
+	sliceDimensionTo( x, 1, {}, {} ); // $ExpectError
+	sliceDimensionTo( x, 1, ( x: number ): number => x, {} ); // $ExpectError
 }
 
 // The compiler throws an error if the function is provided a fourth argument which is not an object...

diff --git a/slice/docs/types/test.ts b/slice/docs/types/test.ts
@@ -87,7 +87,7 @@ import slice = require( './index' );
 	slice( empty( 'uint32', sh, order ), [ null, null ], { 'strict': false } ); // $ExpectType uint32ndarray
 	slice( empty( 'uint16', sh, order ), [ null, null ], { 'strict': false } ); // $ExpectType uint16ndarray
 	slice( empty( 'uint8', sh, order ), [ null, null ], { 'strict': false } ); // $ExpectType uint8ndarray
-	slice( empty( 'uint8c', sh, order ), [ null, null ], { 'strict': false } ); // $ExpectType
+	slice( empty( 'uint8c', sh, order ), [ null, null ], { 'strict': false } ); // $ExpectType uint8cndarray
 
 	slice( empty( 'float64', sh, order ), null, null, { 'strict': false } ); // $ExpectType float64ndarray
 	slice( empty( 'float32', sh, order ), null, null, { 'strict': false } ); // $ExpectType float32ndarray