Skip to content

Commit 7322fb2

Browse files
committed
Update code style
1 parent 2e97e9c commit 7322fb2

File tree

8 files changed

+16
-22
lines changed

8 files changed

+16
-22
lines changed

lib/node_modules/@stdlib/error/tools/id2msg/README.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Returns an error message corresponding to a provided two-character error identif
4646

4747
```javascript
4848
var v = id2msg( '8t' );
49-
// returns 'invalid option. `%s` option must be an array. Option: `%s`.'
49+
// e.g., returns 'invalid option. `%s` option must be an array. Option: `%s`.'
5050
```
5151

5252
If provided an unrecognized error identifier, the function returns `null`.
@@ -82,7 +82,6 @@ var v = id2msg( 'beep_boop' );
8282
var id2msg = require( '@stdlib/error/tools/id2msg' );
8383

8484
var list;
85-
var len;
8685
var v;
8786
var i;
8887

@@ -93,9 +92,8 @@ list = [
9392
'0a',
9493
'9W'
9594
];
96-
len = list.length;
9795

98-
for ( i = 0; i < len; i++ ) {
96+
for ( i = 0; i < list.length; i++ ) {
9997
v = list[ i ];
10098
console.log( 'id: "%s". msg: "%s".', v, id2msg( v ) );
10199
}
@@ -148,7 +146,7 @@ Options:
148146

149147
```bash
150148
$ stdlib-id2msg '8t'
151-
invalid option. `%s` option must be an array. Option: `%s`.
149+
<string>
152150
```
153151

154152
</section>

lib/node_modules/@stdlib/error/tools/id2msg/docs/repl.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
Examples
1717
--------
1818
> var v = {{alias}}( '8t' )
19-
'invalid option. `%s` option must be an array. Option: `%s`.'
19+
<string>
2020

2121
See Also
2222
--------

lib/node_modules/@stdlib/error/tools/id2msg/docs/types/index.d.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
*
2727
* @example
2828
* var v = id2msg( '8t' );
29-
* // returns 'invalid option. `%s` option must be an array. Option: `%s`.'
29+
* // returns <string>
3030
*/
3131
declare function id2msg( id: string ): string | null;
3232

lib/node_modules/@stdlib/error/tools/id2msg/examples/index.js

+1-3
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
var id2msg = require( './../lib' );
2222

2323
var list;
24-
var len;
2524
var v;
2625
var i;
2726

@@ -32,9 +31,8 @@ list = [
3231
'0a',
3332
'9W'
3433
];
35-
len = list.length;
3634

37-
for ( i = 0; i < len; i++ ) {
35+
for ( i = 0; i < list.length; i++ ) {
3836
v = list[ i ];
3937
console.log( 'id: "%s". msg: "%s".', v, id2msg( v ) );
4038
}

lib/node_modules/@stdlib/error/tools/id2msg/lib/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
* var id2msg = require( '@stdlib/error/tools/id2msg' );
2828
*
2929
* var v = id2msg( '8t' );
30-
* // returns 'invalid option. `%s` option must be an array. Option: `%s`.'
30+
* // e.g., returns 'invalid option. `%s` option must be an array. Option: `%s`.'
3131
*/
3232

3333
// MODULES //

lib/node_modules/@stdlib/error/tools/id2msg/lib/main.js

+6-2
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,12 @@ var db;
4141
* @returns {(string|null)} error message
4242
*
4343
* @example
44-
* var v = id2msg( '8t' );
45-
* // returns 'invalid option. `%s` option must be an array. Option: `%s`.'
44+
* var v = id2msg( '9b' );
45+
* // returns <string>
46+
*
47+
* @example
48+
* var v = id2msg( 'boop' );
49+
* // returns null
4650
*/
4751
function id2msg( id ) {
4852
if ( !isString( id ) ) {

lib/node_modules/@stdlib/error/tools/msg2id/README.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Returns a two-character error identifier corresponding to a provided error messa
4646

4747
```javascript
4848
var v = msg2id( 'invalid value. `%s` must be a number. Value: `%s`.' );
49-
// returns '6d'
49+
// e.g., returns '6d'
5050
```
5151

5252
If provided an unrecognized error message, the function returns `null`.
@@ -74,25 +74,21 @@ var v = msg2id( 'beep boop baz' );
7474

7575
## Examples
7676

77-
<!-- TODO: better example -->
78-
7977
<!-- eslint no-undef: "error" -->
8078

8179
```javascript
8280
var msg2id = require( '@stdlib/error/tools/msg2id' );
8381

8482
var list;
85-
var len;
8683
var v;
8784
var i;
8885

8986
list = [
9087
'invalid argument. First argument must be a number and not `NaN`. Value: `%s`.',
9188
'invalid argument. First argument must be a positive integer. Value: `%s`.'
9289
];
93-
len = list.length;
9490

95-
for ( i = 0; i < len; i++ ) {
91+
for ( i = 0; i < list.length; i++ ) {
9692
v = list[ i ];
9793
console.log( 'msg: "%s". id: "%s".', v, msg2id( v ) );
9894
}

lib/node_modules/@stdlib/error/tools/msg2id/examples/index.js

+1-3
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,15 @@
2121
var msg2id = require( './../lib' );
2222

2323
var list;
24-
var len;
2524
var v;
2625
var i;
2726

2827
list = [
2928
'invalid argument. First argument must be a number and not `NaN`. Value: `%s`.',
3029
'invalid argument. First argument must be a positive integer. Value: `%s`.'
3130
];
32-
len = list.length;
3331

34-
for ( i = 0; i < len; i++ ) {
32+
for ( i = 0; i < list.length; i++ ) {
3533
v = list[ i ];
3634
console.log( 'msg: "%s". id: "%s".', v, msg2id( v ) );
3735
}

0 commit comments

Comments
 (0)