Skip to content

Commit

Permalink
docs: rename parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
@kgryte
kgryte committed Sep 18, 2024
1 parent 799e2b9 commit 9f848ed
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 25 deletions.
44 changes: 22 additions & 22 deletions lib/node_modules/@stdlib/wasm/base/array2dtype/docs/types/index.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import { RealOrComplexTypedArray, Complex128Array, Complex64Array, BooleanArray,
/**
* Returns the WebAssembly data type for a provided array.
*
* @param value - input value
* @param array - input value
* @returns data type
*
* @example
Expand All @@ -38,12 +38,12 @@ import { RealOrComplexTypedArray, Complex128Array, Complex64Array, BooleanArray,
* var dt = array2dtype( [ 1, 2, 3 ] );
* // returns 'float64'
*/
declare function array2dtype( value: Float64Array | Array<any> ): 'float64';
declare function array2dtype( array: Float64Array | Array<any> ): 'float64';

Check warning on line 41 in lib/node_modules/@stdlib/wasm/base/array2dtype/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Unexpected any. Specify a different type

/**
* Returns the WebAssembly data type for a provided array.
*
* @param value - input value
* @param array - input value
* @returns data type
*
* @example
Expand All @@ -52,12 +52,12 @@ declare function array2dtype( value: Float64Array | Array<any> ): 'float64';
* var dt = array2dtype( new Float32Array( [ 1, 2, 3 ] ) );
* // returns 'float32'
*/
declare function array2dtype( value: Float32Array ): 'float32';
declare function array2dtype( array: Float32Array ): 'float32';

/**
* Returns the WebAssembly data type for a provided array.
*
* @param value - input value
* @param array - input value
* @returns data type
*
* @example
Expand All @@ -66,12 +66,12 @@ declare function array2dtype( value: Float32Array ): 'float32';
* var dt = array2dtype( new Complex128Array( [ 1, 2, 3, 4 ] ) );
* // returns 'complex128'
*/
declare function array2dtype( value: Complex128Array ): 'complex128';
declare function array2dtype( array: Complex128Array ): 'complex128';

/**
* Returns the WebAssembly data type for a provided array.
*
* @param value - input value
* @param array - input value
* @returns data type
*
* @example
Expand All @@ -80,12 +80,12 @@ declare function array2dtype( value: Complex128Array ): 'complex128';
* var dt = array2dtype( new Complex64Array( [ 1, 2, 3, 4 ] ) );
* // returns 'complex64'
*/
declare function array2dtype( value: Complex64Array ): 'complex64';
declare function array2dtype( array: Complex64Array ): 'complex64';

/**
* Returns the WebAssembly data type for a provided array.
*
* @param value - input value
* @param array - input value
* @returns data type
*
* @example
Expand All @@ -94,12 +94,12 @@ declare function array2dtype( value: Complex64Array ): 'complex64';
* var dt = array2dtype( new Int32Array( [ 1, 2, 3 ] ) );
* // returns 'int32'
*/
declare function array2dtype( value: Int32Array ): 'int32';
declare function array2dtype( array: Int32Array ): 'int32';

/**
* Returns the WebAssembly data type for a provided array.
*
* @param value - input value
* @param array - input value
* @returns data type
*
* @example
Expand All @@ -108,12 +108,12 @@ declare function array2dtype( value: Int32Array ): 'int32';
* var dt = array2dtype( new Int16Array( [ 1, 2, 3 ] ) );
* // returns 'int16'
*/
declare function array2dtype( value: Int16Array ): 'int16';
declare function array2dtype( array: Int16Array ): 'int16';

/**
* Returns the WebAssembly data type for a provided array.
*
* @param value - input value
* @param array - input value
* @returns data type
*
* @example
Expand All @@ -122,12 +122,12 @@ declare function array2dtype( value: Int16Array ): 'int16';
* var dt = array2dtype( new Int8Array( [ 1, 2, 3 ] ) );
* // returns 'int8'
*/
declare function array2dtype( value: Int8Array ): 'int8';
declare function array2dtype( array: Int8Array ): 'int8';

/**
* Returns the WebAssembly data type for a provided array.
*
* @param value - input value
* @param array - input value
* @returns data type
*
* @example
Expand All @@ -136,12 +136,12 @@ declare function array2dtype( value: Int8Array ): 'int8';
* var dt = array2dtype( new Uint32Array( [ 1, 2, 3 ] ) );
* // returns 'uint32'
*/
declare function array2dtype( value: Uint32Array ): 'uint32';
declare function array2dtype( array: Uint32Array ): 'uint32';

/**
* Returns the WebAssembly data type for a provided array.
*
* @param value - input value
* @param array - input value
* @returns data type
*
* @example
Expand All @@ -150,12 +150,12 @@ declare function array2dtype( value: Uint32Array ): 'uint32';
* var dt = array2dtype( new Uint16Array( [ 1, 2, 3 ] ) );
* // returns 'uint16'
*/
declare function array2dtype( value: Uint16Array ): 'uint16';
declare function array2dtype( array: Uint16Array ): 'uint16';

/**
* Returns the WebAssembly data type for a provided array.
*
* @param value - input value
* @param array - input value
* @returns data type
*
* @example
Expand All @@ -176,7 +176,7 @@ declare function array2dtype( value: Uint16Array ): 'uint16';
* var dt = array2dtype( new BooleanArray( [ true, false, true, false ] ) );
* // returns 'uint8'
*/
declare function array2dtype( value: Uint8Array | Uint8ClampedArray | BooleanArray ): 'uint8';
declare function array2dtype( array: Uint8Array | Uint8ClampedArray | BooleanArray ): 'uint8';

/**
* Returns the WebAssembly data type for a provided array.
Expand All @@ -185,7 +185,7 @@ declare function array2dtype( value: Uint8Array | Uint8ClampedArray | BooleanArr
*
* - If provided an argument having an unknown or unsupported type, the function assumes that the values can be stored as double-precision floating-point numbers and returns `'float64'`.
*
* @param value - input value
* @param array - input value
* @returns data type
*
* @example
Expand All @@ -195,7 +195,7 @@ declare function array2dtype( value: Uint8Array | Uint8ClampedArray | BooleanArr
* var dt = array2dtype( 'beep' );
* // returns 'float64'
*/
declare function array2dtype( value: Array<any> | RealOrComplexTypedArray | AccessorArrayLike<any> ): DataType;
declare function array2dtype( array: Array<any> | RealOrComplexTypedArray | AccessorArrayLike<any> ): DataType;

Check warning on line 198 in lib/node_modules/@stdlib/wasm/base/array2dtype/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Unexpected any. Specify a different type

Check warning on line 198 in lib/node_modules/@stdlib/wasm/base/array2dtype/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Unexpected any. Specify a different type


// EXPORTS //
Expand Down
6 changes: 3 additions & 3 deletions lib/node_modules/@stdlib/wasm/base/array2dtype/lib/main.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ var dtype2wasm = require( '@stdlib/wasm/base/dtype2wasm' );
/**
* Returns the WebAssembly data type for a provided array.
*
* @param {Collection} values - input array
* @param {Collection} array - input array
* @returns {string} data type
*
* @example
Expand All @@ -48,8 +48,8 @@ var dtype2wasm = require( '@stdlib/wasm/base/dtype2wasm' );
* var dt = array2dtype( new Float32Array( 4 ) );
* // returns 'float32'
*/
function array2dtype( values ) {
return dtype2wasm( dtype( values ) || 'generic' );
function array2dtype( array ) {
return dtype2wasm( dtype( array ) || 'generic' );
}


Expand Down

1 comment on commit 9f848ed

@stdlib-bot
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage Report

Package Statements Branches Functions Lines
wasm/base/array2dtype $\color{green}104/104$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}104/104$
$\color{green}+100.00\%$
wasm/base/arrays2ptrs $\color{green}271/271$
$\color{green}+100.00\%$ 		$\color{green}9/9$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}271/271$
$\color{green}+100.00\%$
wasm/base/dtype2wasm $\color{green}91/91$
$\color{green}+100.00\%$ 		$\color{green}4/4$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}91/91$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this push.

Please sign in to comment.