chore: clean-up

Author: LoayAhmed304

lib/node_modules/@stdlib/ndarray/base/eye/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # eye
 
-> Create a two-dimensional array with ones on the kth diagonal and zeros elsewhere
+> Create a two-dimensional ndarray with ones on the kth diagonal and zeros elsewhere
 
 <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
 
@@ -42,23 +42,20 @@ var eye = require( '@stdlib/ndarray/base/eye' );
 
 #### eye( dtype, rows, cols, k, order )
 
-Creates a two-dimensional array with ones on the kth diagonal and zeros elsewhere.
+Returns a two-dimensional ndarray with ones on the kth diagonal and zeros elsewhere.
 
 ```javascript
 var getShape = require( '@stdlib/ndarray/shape' );
 var getDType = require( '@stdlib/ndarray/dtype' );
 
-var x = eye( 'float64', 3, 3, 0, 'row-major');
-// returns <ndarray>
+var arr = eye( 'float64', 3, 3, 0, 'row-major');
+// returns <ndarray>[ [ 1.0, 0.0, 0.0 ], [ 0.0, 1.0, 0.0 ], [ 0.0, 0.0, 1.0 ] ]
 
-var sh = getShape( x );
+var sh = getShape( arr );
 // returns [ 3, 3 ]
 
-var dt = String( getDType( x ) );
+var dt = String( getDType( arr ) );
 // returns 'float64'
-
-var v = x.get( 0, 0 );
-// returns 1.0
 ```
 
 The function accepts the following arguments:
@@ -80,8 +77,8 @@ The function accepts the following arguments:
 
 ## Notes
 
--   If the provided [data type][@stdlib/ndarray/dtypes] is complex, the function returns an ndarray whose kth diagonal is filled with complex numbers whose real component equals one and imaginary component equals zero
--   If `k` is greater than the number of columns or less than the number of negative rows, the function returns an array filled with zeros
+-   If the provided [data type][@stdlib/ndarray/dtypes] is complex, the function returns an ndarray whose kth diagonal is filled with complex numbers whose real component equals one and imaginary component equals zero.
+-   If `k` is greater than the number of columns or less than the number of negative rows, the function returns an ndarray filled with zeros.
 
 </section>
 
@@ -99,11 +96,11 @@ The function accepts the following arguments:
 var eye = require( '@stdlib/ndarray/base/eye' );
 var ndarray2array = require( '@stdlib/ndarray/to-array' );
 
-var x = eye( 'float64', 3, 3, 1, 'row-major');
-console.log( ndarray2array( x ) );
+var arr = eye( 'float64', 3, 3, 1, 'row-major');
+console.log( ndarray2array( arr ) );
 
-x = eye( 'complex64', 3, 3, 1, 'row-major');
-console.log( ndarray2array( x ) );
+arr = eye( 'complex64', 3, 3, 1, 'row-major');
+console.log( ndarray2array( arr ) );
 ```
 
 </section>

lib/node_modules/@stdlib/ndarray/base/eye/docs/repl.txt

@@ -1,6 +1,6 @@
 
 {{alias}}( dtype, rows, cols, k, order )
-    Creates a two-dimensional array with ones on the kth diagonal and zeros
+    Returns a two-dimensional ndarray with ones on the kth diagonal and zeros
     elsewhere.
 
     If the provided data type is complex, the function returns an ndarray
@@ -12,10 +12,10 @@
     dtype: string|DataType
         Underlying data type.
 
-    rows: NonNegativeInteger
+    rows: integer
         Number of rows.
 
-    cols: NonNegativeInteger
+    cols: integer
         Number of columns.
 
     k: integer
@@ -32,13 +32,12 @@
 
     Examples
     --------
-    > var arr = {{alias}}( 'float64', 2, 2, 0, 'row-major' )
-    <ndarray>
+    > var arr = {{alias}}( 'float64', 3, 3, 0, 'row-major' )
+    <ndarray>[ [ 1.0, 0.0, 0.0 ], [ 0.0, 1.0, 0.0 ], [ 0.0, 0.0, 1.0 ] ]
     > var sh = {{alias:@stdlib/ndarray/shape}}( arr )
-    [ 2, 2 ]
-    > var data = {{alias:@stdlib/ndarray/to-array}}( arr )
-    [ [ 1, 0 ], [ 0, 1 ] ]
-    --------
+    [ 3, 3 ]
+    > var dt = String( {{alias:@stdlib/ndarray/dtype}}( arr ) )
+    'float64'
 
     See Also
     --------