Fix lint errors and disable rule

Planeshifter · Planeshifter · commit 3b7bbb3829db · 2018-03-24T16:58:04.000-04:00
diff --git a/lib/node_modules/@stdlib/assert/has-prototype/README.md b/lib/node_modules/@stdlib/assert/has-prototype/README.md
@@ -110,7 +110,7 @@ var bool = hasPrototype( bar, Foo.prototype );
     try {
         bool = ( v instanceof superProto );
     } catch ( error ) {
-        // type error...
+        // Encountered a type error...
         console.error( error.message );
     }
 
diff --git a/lib/node_modules/@stdlib/assert/is-native-function/README.md b/lib/node_modules/@stdlib/assert/is-native-function/README.md
@@ -62,7 +62,7 @@ bool = isNativeFunction( beep );
 
 ## Examples
 
-<!-- eslint-disable no-empty-function, no-restricted-syntax -->
+<!-- eslint-disable no-empty-function, no-restricted-syntax, stdlib/no-builtin-math -->
 
 <!-- eslint no-undef: "error" -->
 
diff --git a/lib/node_modules/@stdlib/assert/is-unity-probability-array/README.md b/lib/node_modules/@stdlib/assert/is-unity-probability-array/README.md
@@ -64,7 +64,8 @@ bool = isUnityProbabilityArray( [ 3.14, 0.0 ] );
     for ( i = 0; i < arr.length; i++ ) {
         sum += arr[ i ];
     }
-    // sum => 0.9999999999999999
+    console.log( sum );
+    // => 0.9999999999999999
     ```
 
     To account for numerical error, the function tests if array elements sum to approximately one; specifically,
diff --git a/lib/node_modules/@stdlib/assert/is-uri/README.md b/lib/node_modules/@stdlib/assert/is-uri/README.md
@@ -122,7 +122,6 @@ bool = isURI( 'telnet://192.0.2.16:80/' );
 bool = isURI( 'urn:oasis:names:specification:docbook:dtd:xml:4.1.2' );
 // returns true
 
-
 /* Invalid */
 
 // No scheme:
diff --git a/lib/node_modules/@stdlib/buffer/to-json/README.md b/lib/node_modules/@stdlib/buffer/to-json/README.md
@@ -52,8 +52,8 @@ var buf = array2buffer( [ 1, 2 ] );
 var json = toJSON( buf );
 /* returns
     {
-        "type": "Buffer",
-        "data": [ 1, 2 ]
+        'type': 'Buffer',
+        'data': [ 1, 2 ]
     }
 */
 ```
diff --git a/lib/node_modules/@stdlib/fs/exists/README.md b/lib/node_modules/@stdlib/fs/exists/README.md
@@ -148,7 +148,6 @@ console.log( exists.sync( __dirname ) );
 console.log( exists.sync( 'beepboop' ) );
 // => false
 
-
 /* Async */
 
 exists( __dirname, done );
diff --git a/lib/node_modules/@stdlib/fs/read-dir/README.md b/lib/node_modules/@stdlib/fs/read-dir/README.md
@@ -42,7 +42,7 @@ function onRead( error, data ) {
         console.error( error );
     } else {
         console.log( data );
-        // returns [...]
+        // => [...]
     }
 }
 ```
@@ -57,7 +57,7 @@ if ( out instanceof Error ) {
     throw out;
 }
 console.log( out );
-// returns [...]
+// => [...]
 ```
 
 </section>
@@ -123,7 +123,6 @@ out = readDir.sync( 'beepboop' );
 console.log( out instanceof Error );
 // => true
 
-
 /* Async */
 
 readDir( __dirname, onRead );
diff --git a/lib/node_modules/@stdlib/fs/read-file-list/README.md b/lib/node_modules/@stdlib/fs/read-file-list/README.md
@@ -97,7 +97,6 @@ files = readFileList.sync( [ 'beepboop' ], {
 console.log( files instanceof Error );
 // => true
 
-
 /* Async */
 
 readFileList( [ __filename ], onFiles );
diff --git a/lib/node_modules/@stdlib/fs/read-file/README.md b/lib/node_modules/@stdlib/fs/read-file/README.md
@@ -127,7 +127,6 @@ file = readFile.sync( 'beepboop', {
 console.log( file instanceof Error );
 // => true
 
-
 /* Async */
 
 readFile( __filename, onFile );
diff --git a/lib/node_modules/@stdlib/os/arch/README.md b/lib/node_modules/@stdlib/os/arch/README.md
@@ -36,7 +36,7 @@ Operating system CPU architecture.
 
 ```javascript
 console.log( ARCH );
-// returns <string>
+// => <string>
 ```
 
 </section>
diff --git a/lib/node_modules/@stdlib/os/platform/README.md b/lib/node_modules/@stdlib/os/platform/README.md
@@ -36,7 +36,7 @@ var PLATFORM = require( '@stdlib/os/platform' );
 
 ```javascript
 console.log( PLATFORM );
-// returns <string>
+// => <string>
 ```
 
 </section>
diff --git a/lib/node_modules/@stdlib/random/base/box-muller/README.md b/lib/node_modules/@stdlib/random/base/box-muller/README.md
@@ -119,6 +119,8 @@ for ( i = 0; i < 100; i++ ) {
 
 If provided a PRNG for uniformly distributed numbers which does not have a `SEED` property, this value is `null`.
 
+<!-- eslint-disable stdlib/no-builtin-math -->
+
 ```javascript
 var rand = randn.factory({
     'prng': Math.random
@@ -139,6 +141,8 @@ var min = randn.MIN;
 
 Note that this value is computed based on the minimum value of the underlying PRNG for uniformly distributed numbers. If the underlying PRNG does not have a `MIN` property, this value is `null`.
 
+<!-- eslint-disable stdlib/no-builtin-math -->
+
 ```javascript
 var rand = randn.factory({
     'prng': Math.random
@@ -159,6 +163,8 @@ var max = randn.MAX;
 
 Note that this value is computed based on the minimum value of the underlying PRNG for uniformly distributed numbers. If the underlying PRNG does not have a `MIN` property, this value is `null`.
 
+<!-- eslint-disable stdlib/no-builtin-math -->
+
 ```javascript
 var rand = randn.factory({
     'prng': Math.random
diff --git a/lib/node_modules/@stdlib/random/base/improved-ziggurat/README.md b/lib/node_modules/@stdlib/random/base/improved-ziggurat/README.md
@@ -119,6 +119,8 @@ for ( i = 0; i < 100; i++ ) {
 
 If provided a PRNG for uniformly distributed numbers which does not have a `SEED` property, this value is `null`.
 
+<!-- eslint-disable stdlib/no-builtin-math -->
+
 ```javascript
 var rand = randn.factory({
     'prng': Math.random
diff --git a/lib/node_modules/@stdlib/tools/cli/README.md b/lib/node_modules/@stdlib/tools/cli/README.md
@@ -115,6 +115,8 @@ var cli = new CLI( opts );
 
 When the command-line flag `--help` is set, a command-line interface instance prints help text and immediately exits the calling process. To specify the printed text, set the `help` option.
 
+<!-- eslint-disable stdlib/return-annotations-marker -->
+
 ```javascript
 var opts = {
     'help': 'Usage: boop [options] <beep>',
diff --git a/lib/node_modules/@stdlib/utils/function-name/README.md b/lib/node_modules/@stdlib/utils/function-name/README.md
@@ -34,6 +34,8 @@ var functionName = require( '@stdlib/utils/function-name' );
 
 Returns the name of a `function`.
 
+<!-- eslint-disable stdlib/no-builtin-math -->
+
 ```javascript
 var v = functionName( Math.sqrt );
 // returns 'sqrt'
@@ -52,8 +54,8 @@ If provided a value which is not a `function`, the function **throws** a `TypeEr
 
 ```javascript
 try {
-    // throws...
     functionName( 'beep' );
+    // throws error...
 } catch ( err ) {
     console.error( err );
 }
@@ -81,7 +83,7 @@ try {
 
 ## Examples
 
-<!-- eslint-disable no-empty-function, no-restricted-syntax, func-names -->
+<!-- eslint-disable no-empty-function, no-restricted-syntax, func-names, stdlib/no-builtin-math -->
 
 <!-- eslint no-undef: "error" -->
 
diff --git a/lib/node_modules/@stdlib/utils/inmap-right-async/README.md b/lib/node_modules/@stdlib/utils/inmap-right-async/README.md
@@ -113,7 +113,7 @@ function fcn( value, index, next ) {
 
 function done( error, collection ) {
     if ( error ) {
-        // ignore error...
+        // Ignore error...
     }
     console.log( collection );
     // => [ 1000, 2000, 'beep: 2' ]
diff --git a/lib/node_modules/@stdlib/utils/inmap-right/README.md b/lib/node_modules/@stdlib/utils/inmap-right/README.md
@@ -135,7 +135,7 @@ var mean = context.sum / context.count;
 
     -   The function does **not** skip `undefined` elements.
 
-        <!-- eslint-disable no-sparse-arrays -->
+        <!-- eslint-disable no-sparse-arrays, stdlib/return-annotations-marker -->
 
         ```javascript
         function log( value, index ) {
diff --git a/lib/node_modules/@stdlib/utils/none-by-right/README.md b/lib/node_modules/@stdlib/utils/none-by-right/README.md
@@ -124,7 +124,7 @@ var mean = context.sum / context.count;
 
 -   The function does **not** skip `undefined` elements.
 
-    <!-- eslint-disable no-sparse-arrays -->
+    <!-- eslint-disable no-sparse-arrays, stdlib/return-annotations-marker -->
 
     ```javascript
     function log( value, index ) {
diff --git a/lib/node_modules/@stdlib/utils/reduce-right/README.md b/lib/node_modules/@stdlib/utils/reduce-right/README.md
@@ -131,7 +131,7 @@ var mean = out / context.count;
 
     -   The function does **not** skip `undefined` elements.
 
-        <!-- eslint-disable no-sparse-arrays -->
+        <!-- eslint-disable no-sparse-arrays, stdlib/return-annotations-marker -->
 
         ```javascript
         function log( accumulator, value, index ) {
diff --git a/lib/node_modules/@stdlib/utils/some-by-right/README.md b/lib/node_modules/@stdlib/utils/some-by-right/README.md
@@ -124,7 +124,7 @@ var mean = context.sum / context.count;
 
 -   The function does **not** skip `undefined` elements.
 
-    <!-- eslint-disable no-sparse-arrays -->
+    <!-- eslint-disable no-sparse-arrays, stdlib/return-annotations-marker -->
 
     ```javascript
     function log( value, index ) {
diff --git a/lib/node_modules/@stdlib/utils/some-by/README.md b/lib/node_modules/@stdlib/utils/some-by/README.md
@@ -124,7 +124,7 @@ var mean = context.sum / context.count;
 
 -   The function does **not** skip `undefined` elements.
 
-    <!-- eslint-disable no-sparse-arrays -->
+    <!-- eslint-disable no-sparse-arrays, stdlib/return-annotations-marker -->
 
     ```javascript
     function log( value, index ) {
diff --git a/lib/node_modules/@stdlib/utils/timeit/README.md b/lib/node_modules/@stdlib/utils/timeit/README.md
@@ -57,14 +57,14 @@ function done( error, results ) {
         throw error;
     }
     console.dir( results );
-    /* e.g., returns
+    /* e.g., =>
         {
-            "iterations": 1000000,
-            "repeats": 3,
-            "min": [0,135734733],       // [seconds,nanoseconds]
-            "elapsed": 0.135734733,     // seconds
-            "rate": 7367311.062526641,  // iterations/second
-            "times": [                  // raw timing results
+            'iterations': 1000000,
+            'repeats': 3,
+            'min': [0,135734733],       // [seconds,nanoseconds]
+            'elapsed': 0.135734733,     // seconds
+            'rate': 7367311.062526641,  // iterations/second
+            'times': [                  // raw timing results
                 [0,145641393],
                 [0,135734733],
                 [0,140462721]

Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,7 @@ var bool = hasPrototype( bar, Foo.prototype );`
`110`	`110`	`try {`
`111`	`111`	`bool = ( v instanceof superProto );`
`112`	`112`	`} catch ( error ) {`
`113`		`- // type error...`
	`113`	`+ // Encountered a type error...`
`114`	`114`	`console.error( error.message );`
`115`	`115`	`}`
`116`	`116`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,8 @@ bool = isUnityProbabilityArray( [ 3.14, 0.0 ] );`
`64`	`64`	`for ( i = 0; i < arr.length; i++ ) {`
`65`	`65`	`sum += arr[ i ];`
`66`	`66`	`}`
`67`		`- // sum => 0.9999999999999999`
	`67`	`+ console.log( sum );`
	`68`	`+ // => 0.9999999999999999`
`68`	`69`	```
`69`	`70`
`70`	`71`	`To account for numerical error, the function tests if array elements sum to approximately one; specifically,`
Original file line number	Diff line number	Diff line change
`@@ -52,8 +52,8 @@ var buf = array2buffer( [ 1, 2 ] );`
`52`	`52`	`var json = toJSON( buf );`
`53`	`53`	`/* returns`
`54`	`54`	`{`
`55`		`- "type": "Buffer",`
`56`		`- "data": [ 1, 2 ]`
	`55`	`+ 'type': 'Buffer',`
	`56`	`+ 'data': [ 1, 2 ]`
`57`	`57`	`}`
`58`	`58`	`*/`
`59`	`59`	```