Skip to content

Commit 41c55d8

Browse files
authored
docs: update number/int16/base TypeScript declarations
PR-URL: #9898 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 79d674d commit 41c55d8

1 file changed

Lines changed: 13 additions & 5 deletions

File tree

  • lib/node_modules/@stdlib/number/int16/base/docs/types

lib/node_modules/@stdlib/number/int16/base/docs/types/index.d.ts

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,26 @@ import identity = require( '@stdlib/number/int16/base/identity' );
2727
*/
2828
interface Namespace {
2929
/**
30-
* Evaluates the identity function for a signed 16-bit integer.
30+
* Evaluates the identity function for a signed 16-bit integer `x`.
3131
*
3232
* @param x - input value
3333
* @returns input value
3434
*
3535
* @example
36-
* var v = ns.identity( 5 );
37-
* // returns 5
36+
* var v = ns.identity( 1 );
37+
* // returns 1
3838
*
3939
* @example
40-
* var v = ns.identity( -3 );
41-
* // returns -3
40+
* var v = ns.identity( 2 );
41+
* // returns 2
42+
*
43+
* @example
44+
* var v = ns.identity( 0 );
45+
* // returns 0
46+
*
47+
* @example
48+
* var v = ns.identity( 32767 );
49+
* // returns 32767
4250
*/
4351
identity: typeof identity;
4452
}

0 commit comments

Comments
 (0)