chore: code review

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: passed
  - task: lint_repl_help
    status: passed
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---

Author: aayush0325

lib/node_modules/@stdlib/lapack/base/dlapy2/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # dlapy2
 
-> LAPACK routine to calculate `sqrt( x^2 + y^2 )` in a manner which doesn't cause unnecessary overflow.
+> LAPACK routine to calculate `sqrt(x^2 + y^2)` in a manner which doesn't cause unnecessary overflow.
 
 <section class="usage">
 
@@ -32,7 +32,7 @@ var dlapy2 = require( '@stdlib/lapack/base/dlapy2' );
 
 #### dlapy2( x, y )
 
-Calculate `sqrt( x^2 + y^2 )` in a manner which doesn't cause unnecessary overflow.
+Calculate `sqrt(x^2 + y^2)` in a manner which doesn't cause unnecessary overflow.
 
 ```javascript
 var out = dlapy2( 3.0, 4.0 );
@@ -41,8 +41,8 @@ var out = dlapy2( 3.0, 4.0 );
 
 The function has the following parameters:
 
--   **x**: input number.
--   **y**: input number.
+-   **x**: first input number.
+-   **y**: second input number.
 
 </section>
 

lib/node_modules/@stdlib/lapack/base/dlapy2/docs/repl.txt

@@ -1,11 +1,8 @@
 
 {{alias}}( x, y )
-    Returns sqrt( x^2 + y^2 ) in a manner which doesn't cause unnecessary
+    Returns `sqrt(x^2 + y^2)` in a manner which doesn't cause unnecessary
     overflow.
 
-    If either argument is `NaN` and the other argument is not `+-Infinity`,
-    the function returns `NaN`.
-
     Parameters
     ----------
     x: number
@@ -17,14 +14,12 @@
     Returns
     -------
     out: number
-        Sqrt( x^2 + y^2 ).
+        Square root of sum of squares.
 
     Examples
     --------
     > var h = {{alias}}( -5.0, 12.0 )
     13.0
-    > h = {{alias}}( NaN, 12.0 )
-    NaN
     > h = {{alias}}( -0.0, -0.0 )
     0.0
 

lib/node_modules/@stdlib/lapack/base/dlapy2/docs/types/index.d.ts

@@ -19,21 +19,17 @@
 // TypeScript Version: 4.1
 
 /**
-* LAPACK routine to calculate sqrt( x^2 + y^2 ) in a manner which doesn't cause unnecessary overflow.
+* LAPACK routine to calculate `sqrt(x^2 + y^2)` in a manner which doesn't cause unnecessary overflow.
 *
-* @param x - number
-* @param y - number
-* @returns sqrt( x^2 + y^2 )
+* @param x - first input number
+* @param y - second input number
+* @returns `sqrt(x^2 + y^2)`
 *
 * @example
 * var h = dlapy2( -5.0, 12.0 );
 * // returns 13.0
 *
 * @example
-* var h = dlapy2( NaN, 12.0 );
-* // returns NaN
-*
-* @example
 * var h = dlapy2( -0.0, -0.0 );
 * // returns 0.0
 */

lib/node_modules/@stdlib/lapack/base/dlapy2/lib/index.js

@@ -19,15 +19,15 @@
 'use strict';
 
 /**
-* LAPACK routine to calculate sqrt( x^2 + y^2 ) in a manner which doesn't cause unnecessary overflow.
+* LAPACK routine to calculate `sqrt(x^2 + y^2)` in a manner which doesn't cause unnecessary overflow.
 *
 * @module @stdlib/lapack/base/dlapy2
 *
 * @example
 * var dlapy2 = require( '@stdlib/lapack/base/dlapy2' );
 *
 * var out = dlapy2( 3.0, 4.0 );
-* // returns 5
+* // returns 5.0
 */
 
 // MODULES //

lib/node_modules/@stdlib/lapack/base/dlapy2/lib/main.js

@@ -30,15 +30,15 @@ var pow = require( '@stdlib/math/base/special/pow' );
 // MAIN //
 
 /**
-* Returns sqrt( x^2 + y^2 ) in a manner which doesn't cause unnecessary overflow.
+* Returns `sqrt(x^2 + y^2)` in a manner which doesn't cause unnecessary overflow.
 *
 * @private
-* @param {number} x - input number
-* @param {number} y - input number
-* @returns {number} sqrt( x^2 + y^2 )
+* @param {number} x - first input number
+* @param {number} y - second input number
+* @returns {number} `sqrt(x^2 + y^2)`
 *
 * @example
-* var out = dlapy2( 3.0, 4.0, );
+* var out = dlapy2( 3.0, 4.0 );
 * // returns 5.0
 */
 function dlapy2( x, y ) {

lib/node_modules/@stdlib/lapack/base/dlapy2/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/lapack/base/dlapy2",
   "version": "0.0.0",
-  "description": "LAPACK routine to calculate sqrt( x^2 + y^2 ) in a manner which doesn't cause unnecessary overflow.",
+  "description": "LAPACK routine to calculate `sqrt(x^2 + y^2)` in a manner which doesn't cause unnecessary overflow.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

lib/node_modules/@stdlib/lapack/base/dlapy2/test/test.js

@@ -26,7 +26,6 @@ var EPS = require( '@stdlib/constants/float64/eps' );
 var abs = require( '@stdlib/math/base/special/abs' );
 var sqrt = require( '@stdlib/math/base/special/sqrt' );
 var pow = require( '@stdlib/math/base/special/pow' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' );
 var dlapy2 = require( './../lib' );
 
@@ -44,21 +43,6 @@ tape( 'main export is a function', function test( t ) {
 	t.end();
 });
 
-tape( 'the function returns `NaN` if either argument is `NaN` but not `+-infinity`', function test( t ) {
-	var h;
-
-	h = dlapy2( NaN, 3.14 );
-	t.strictEqual( isnan( h ), true, 'returns expected value' );
-
-	h = dlapy2( 3.14, NaN );
-	t.strictEqual( isnan( h ), true, 'returns expected value' );
-
-	h = dlapy2( NaN, NaN );
-	t.strictEqual( isnan( h ), true, 'returns expected value' );
-
-	t.end();
-});
-
 tape( 'the function returns `+0` if both arguments are `+-0`', function test( t ) {
 	var h;
 
@@ -125,7 +109,7 @@ tape( 'the function avoids overflow', function test( t ) {
 	t.strictEqual( h, PINF, 'returns expected value' );
 
 	h = dlapy2( 1.0e308, 1.0e308 );
-	t.strictEqual( h, 1.4142135623730951e308, 'avoids overflow' );
+	t.strictEqual( h, 1.4142135623730951e308, 'returns expected value' );
 
 	t.end();
 });
@@ -137,7 +121,7 @@ tape( 'the function avoids underflow', function test( t ) {
 	t.strictEqual( h, 0.0, 'returns 0' );
 
 	h = dlapy2( 1.0e-200, 1.0e-200 );
-	t.strictEqual( h, 1.414213562373095e-200, 'avoids underflow' );
+	t.strictEqual( h, 1.414213562373095e-200, 'returns expected value' );
 
 	t.end();
 });