docs: add description

---
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: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - 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: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---

Author: aayush0325

lib/node_modules/@stdlib/lapack/base/dppequ/lib/base.js

@@ -30,13 +30,13 @@ var min = require( '@stdlib/math/base/special/min' );
 /**
 * Computes the row and column scaling factors intended to equilibrate a symmetric positive definite matrix `A` in packed storage and reduce it's condition number (with respect to the two-norm).
 *
-* @param {string} order - specifies whether `AP` is packed in row-major or column-major order
-* @param {string} uplo - 'Upper' or 'Lower' triangle of `A` is stored
+* @param {string} order - storage layout
+* @param {string} uplo - specifies whether upper or lower triangle of `A` is stored ( `upper` or `lower` )
 * @param {NonNegativeInteger} N - order of the matrix `A`
-* @param {Float64Array} AP - array containing the upper or lower triangle of `A` in packed form
+* @param {Float64Array} AP - array containing the upper or lower triangle of `A` in packed form, expectes `N * (  N + 1 ) / 2` indexed elements
 * @param {integer} strideAP - stride length for `AP`
 * @param {integer} offsetAP - starting index for `AP`
-* @param {Float64Array} S - array to store the scale factors of `A`
+* @param {Float64Array} S - array to store the scale factors of `A`, expects `N` indexed elements
 * @param {integer} strideS - stride length for `S`
 * @param {integer} offsetS - starting index for `S`
 * @param {Float64Array} out - array to store the output

lib/node_modules/@stdlib/lapack/base/dppequ/lib/dppequ.js

@@ -30,11 +30,11 @@ var base = require( './base.js' );
 /**
 * Computes the row and column scaling factors intended to equilibrate a symmetric positive definite matrix `A` in packed storage and reduce it's condition number (with respect to the two-norm).
 *
-* @param {string} order - specifies whether `AP` is packed in row-major or column-major order
-* @param {string} uplo - 'Upper' or 'Lower' triangle of `A` is stored
+* @param {string} order - storage layout
+* @param {string} uplo - specifies whether upper or lower triangle of `A` is stored ( `upper` or `lower` )
 * @param {NonNegativeInteger} N - order of the matrix `A`
-* @param {Float64Array} AP - array containing the upper or lower triangle of `A` in packed form
-* @param {Float64Array} S - array to store the scale factors of `A`
+* @param {Float64Array} AP - array containing the upper or lower triangle of `A` in packed form, expectes `N * (  N + 1 ) / 2` indexed elements
+* @param {Float64Array} S - array to store the scale factors of `A`, expects `N` indexed elements
 * @param {Float64Array} out - array to store the output
 * @throws {TypeError} first argument must be a valid order
 * @throws {RangeError} third argument must be a nonnegative integer

lib/node_modules/@stdlib/lapack/base/dppequ/lib/ndarray.js

@@ -30,13 +30,13 @@ var base = require( './base.js' );
 /**
 * Computes the row and column scaling factors intended to equilibrate a symmetric positive definite matrix `A` in packed storage and reduce it's condition number (with respect to the two-norm) using alternative indexing semantics.
 *
-* @param {string} order - specifies whether `AP` is packed in row-major or column-major order
-* @param {string} uplo - 'Upper' or 'Lower' triangle of `A` is stored
+* @param {string} order - storage layout
+* @param {string} uplo - specifies whether upper or lower triangle of `A` is stored ( `upper` or `lower` )
 * @param {NonNegativeInteger} N - order of the matrix `A`
-* @param {Float64Array} AP - array containing the upper or lower triangle of `A` in packed form
+* @param {Float64Array} AP - array containing the upper or lower triangle of `A` in packed form, expectes `N * (  N + 1 ) / 2` indexed elements
 * @param {integer} strideAP - stride length for `AP`
 * @param {integer} offsetAP - starting index for `AP`
-* @param {Float64Array} S - array to store the scale factors of `A`
+* @param {Float64Array} S - array to store the scale factors of `A`, expects `N` indexed elements
 * @param {integer} strideS - stride length for `S`
 * @param {integer} offsetS - starting index for `S`
 * @param {Float64Array} out - array to store the output