fix(assert): resolve README lint errors and improve formatting

Author: abhishekblue

lib/node_modules/@stdlib/assert/has-same-constructor/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # hasSameConstructor
 
-> Test whether two provided values have the same constructor.
+> Test whether two provided arguments have the same constructor.
 
 <section class="usage">
 
@@ -32,22 +32,16 @@ var hasSameConstructor = require( '@stdlib/assert/has-same-constructor' );
 
 #### hasSameConstructor( x, y )
 
-Returns a `boolean` indicating whether two given values has same contructor function.
+Tests if two arguments `x` and `y` have the same constructor.
 
 ```javascript
-var x = 5
-var y = 10;
-var bool = hasSameConstructor( x, y );
+var bool = hasSameConstructor( 5, 10 );
 // returns true
 
-x = 5;
-y = [];
-bool = hasSameConstructor( x, y );
+bool = hasSameConstructor( 5, [] );
 // returns false
 
-x = [];
-y = [];
-bool = hasSameConstructor( x, y );
+bool = hasSameConstructor( [], [] );
 // returns true
 ```
 
@@ -91,16 +85,16 @@ bool = hasSameConstructor( x, y );
 ```javascript
 var hasSameConstructor = require( '@stdlib/assert/has-same-constructor' );
 
-var bool = hasSameConstructor( [1, 2, 3], ['a', 'b', 'c'] );
+var bool = hasSameConstructor([1, 2, 3], ['a', 'b', 'c']);
 // returns true
 
-bool = hasSameConstructor( [1, 2, 3], { 'key': 'value' } );
+bool = hasSameConstructor([1, 2, 3], { 'key': 'value' });
 // returns false
 
 bool = hasSameConstructor({ 'name': 'Alice' }, { 'age': 30 });
 // returns true
 
-bool = hasSameConstructor( { 'name': 'Alice' }, new Date() );
+bool = hasSameConstructor({'name': 'Alice' }, new Date());
 // returns false
 
 bool = hasSameConstructor( new Date(), new Date() );
@@ -109,7 +103,7 @@ bool = hasSameConstructor( new Date(), new Date() );
 bool = hasSameConstructor( null, { 'name': 'Alice' } );
 // returns false
 
-bool = hasSameConstructor( undefined, [1, 2, 3] );
+bool = hasSameConstructor( void 0, [1, 2, 3] );
 // returns false
 
 bool = hasSameConstructor( 42, 3.14 );

lib/node_modules/@stdlib/assert/has-same-constructor/benchmark/benchmark.js

@@ -33,6 +33,8 @@ var hasSameConstructor = require( './../lib' );
 bench( pkg, function benchmark( b ) {
 	var values;
 	var bool;
+	var x;
+	var y;
 	var i;
 
 	values = [
@@ -51,13 +53,14 @@ bench( pkg, function benchmark( b ) {
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		bool = hasSameConstructor( values[ i % values.length ], values[ (i+1) % values.length ] );
+		x = values[ i%values.length ];
+		y = values[ (i+1)%values.length ];
+		bool = hasSameConstructor( x, y );
 		if ( typeof bool !== 'boolean' ) {
 			b.fail( 'should return a boolean' );
 		}
 	}
 	b.toc();
-
 	if ( !isBoolean( bool ) ) {
 		b.fail( 'should return a boolean' );
 	}

lib/node_modules/@stdlib/assert/has-same-constructor/docs/repl.txt

@@ -4,16 +4,16 @@
 
     Parameters
     ----------
-    a: any
+    x: any
         First input value.
 
-    b: any
+    y: any
         Second input value.
 
     Returns
     -------
     bool: boolean
-        Boolean indicating whether two values have same constructor.
+        Boolean indicating whether two arguments have the same constructor.
 
     Examples
     --------

lib/node_modules/@stdlib/assert/has-same-constructor/docs/types/index.d.ts

@@ -37,7 +37,6 @@
 * var bool = hasSameConstructor(new String("Hello"), "World");
 * // returns true
 */
-
 declare function hasSameConstructor( x: any, y: any ): boolean;
 
 

lib/node_modules/@stdlib/assert/has-same-constructor/examples/index.js

@@ -22,31 +22,31 @@
 
 var hasSameConstructor = require( './../lib' );
 
-var bool = hasSameConstructor( [1, 2, 3], ['a', 'b', 'c'] );
+var bool = hasSameConstructor([1, 2, 3], ['a', 'b', 'c']);
 console.log( bool );
 // => true
 
-bool = hasSameConstructor( [1, 2, 3], { key: 'value' });
+bool = hasSameConstructor([1, 2, 3], { key: 'value' });
 console.log( bool );
 // => false
 
 bool = hasSameConstructor({ name: 'Alice' }, { age: 30 });
 console.log( bool );
 // => true
 
-bool = hasSameConstructor({ name: 'Alice' }, new Date() );
+bool = hasSameConstructor({ name: 'Alice' }, new Date());
 console.log( bool );
 // => false
 
 bool = hasSameConstructor( new Date(), new Date() );
 console.log( bool );
 // => true
 
-bool = hasSameConstructor( null, { name: 'Alice' });
+bool = hasSameConstructor(null, { name: 'Alice' });
 console.log( bool );
 // => false
 
-bool = hasSameConstructor( undefined, [1, 2, 3] );
+bool = hasSameConstructor(undefined, [1, 2, 3]);
 console.log( bool );
 // => false
 
@@ -58,6 +58,6 @@ bool = hasSameConstructor( 42, 'Hello' );
 console.log( bool );
 // => false
 
-bool = hasSameConstructor( function () {}, () => {} );
+bool = hasSameConstructor(function () {}, () => {});
 console.log( bool );
 // => true

lib/node_modules/@stdlib/assert/has-same-constructor/lib/index.js

@@ -26,22 +26,13 @@
 * @example
 * var hasSameConstructor = require( '@stdlib/assert/has-same-constructor' );
 *
-* @example
-* var x = new Number(5);
-* var y = new Number(10);
-* var bool = hasSameConstructor( x, y );
+* var bool = hasSameConstructor( new Number(5), new Number(10) );
 * // returns true
 *
-* @example
-* var x = new Number(5);
-* var y = [];
-* var bool = hasSameConstructor( x, y );
+* bool = hasSameConstructor( new Number(5), [] );
 * // returns false
 *
-* @example
-* var x = [];
-* var y = [];
-* var bool = hasSameConstructor( x, y );
+* bool = hasSameConstructor( [], [] );
 * // returns true
 */
 

lib/node_modules/@stdlib/assert/has-same-constructor/lib/main.js

@@ -28,32 +28,19 @@
 * @returns {boolean} boolean indicating whether two arguments have the same native class
 *
 * @example
-* var x = new Number(5);
-* var y = new Number(10);
-* var bool = hasSameConstructor( x, y );
+* var bool = hasSameConstructor( new Number(5), new Number(10) );
 * // returns true
 *
 * @example
-* var x = new Number(5);
-* var y = [];
-* var bool = hasSameConstructor( x, y );
+* var bool = hasSameConstructor( new Number(5), [] );
 * // returns false
 *
 * @example
-* var x = [];
-* var y = [];
-* var bool = hasSameConstructor( x, y );
+* var bool = hasSameConstructor( [], [] );
 * // returns true
 */
-// function hasSameConstructor( x, y ) {
-//     if ( !x || !y ) {
-//         return false;
-//     }
-//     return x.constructor === y.constructor;
-// }
-
 function hasSameConstructor( x, y ) {
-    if (x == null || y == null) {  // Check for null or undefined only
+    if (x == null || y == null) {
         return false;
     }
     return x.constructor === y.constructor;