docs: update docs

---
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: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---

Author: aayush0325

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

@@ -31,10 +31,10 @@ interface Routine {
 	* -   the input vector is `[alpha; x]`, where `alpha` is a scalar and `x` is a real `(n-1)`-element vector.
 	* -   the result of applying `H` to `[alpha; x]` is `[beta; 0]`, with `beta` being a scalar and the rest of the vector zeroed.
 	* -   if all elements of `x` are zero, then `tau = 0` and `H` is the identity matrix.
-	* -   otherwise, `1 <= tau <= 2` and `H` is orthogonal, i.e., `H^T * H = I`.
+	* -   otherwise, `1 <= tau <= 2`
 	*
 	* @param N - order of matrix `A`
-	* @param X - overwritten by the vector `V` on exit
+	* @param X - overwritten by the vector `V` on exit, expects `N - 1` indexed elements
 	* @param incx - stride length for `X`
 	* @param out - array to store `alpha` and `tau`, first indexed element stores `alpha` and the second indexed element stores `tau`
 	* @returns overwrites the array `X` and `out` in place
@@ -60,10 +60,10 @@ interface Routine {
 	* -   the input vector is `[alpha; x]`, where `alpha` is a scalar and `x` is a real `(n-1)`-element vector.
 	* -   the result of applying `H` to `[alpha; x]` is `[beta; 0]`, with `beta` being a scalar and the rest of the vector zeroed.
 	* -   if all elements of `x` are zero, then `tau = 0` and `H` is the identity matrix.
-	* -   otherwise, `1 <= tau <= 2` and `H` is orthogonal, i.e., `H^T * H = I`.
+	* -   otherwise, `1 <= tau <= 2`
 	*
 	* @param N - order of matrix `A`
-	* @param X - overwritten by the vector `V` on exit
+	* @param X - overwritten by the vector `V` on exit, expects `N - 1` indexed elements
 	* @param strideX - stride length for `X`
 	* @param offsetX - starting index of `X`
 	* @param out - array to store `alpha` and `tau`, first indexed element stores `alpha` and the second indexed element stores `tau`
@@ -93,10 +93,10 @@ interface Routine {
 * -   the input vector is `[alpha; x]`, where `alpha` is a scalar and `x` is a real `(n-1)`-element vector.
 * -   the result of applying `H` to `[alpha; x]` is `[beta; 0]`, with `beta` being a scalar and the rest of the vector zeroed.
 * -   if all elements of `x` are zero, then `tau = 0` and `H` is the identity matrix.
-* -   otherwise, `1 <= tau <= 2` and `H` is orthogonal, i.e., `H^T * H = I`.
+* -   otherwise, `1 <= tau <= 2`
 *
 * @param N - order of matrix `A`
-* @param X - overwritten by the vector `V` on exit
+* @param X - overwritten by the vector `V` on exit, expects `N - 1` indexed elements
 * @param incx - stride length for `X`
 * @param out - array to store `alpha` and `tau`, first indexed element stores `alpha` and the second indexed element stores `tau`
 * @returns overwrites the array `X` and `out` in place

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

@@ -39,11 +39,11 @@ var dlapy2 = require( './dlapy2.js' );
 * -   the input vector is `[alpha; x]`, where `alpha` is a scalar and `x` is a real `(n-1)`-element vector.
 * -   the result of applying `H` to `[alpha; x]` is `[beta; 0]`, with `beta` being a scalar and the rest of the vector zeroed.
 * -   if all elements of `x` are zero, then `tau = 0` and `H` is the identity matrix.
-* -   otherwise, `1 <= tau <= 2` and `H` is orthogonal, i.e., `H^T * H = I`.
+* -   otherwise, `1 <= tau <= 2`
 *
 * @private
 * @param {NonNegativeInteger} N - order of matrix `A`
-* @param {Float64Array} X - overwritten by the vector `V` on exit
+* @param {Float64Array} X - overwritten by the vector `V` on exit, expects `N - 1` indexed elements
 * @param {integer} strideX - stride length for `X`
 * @param {NonNegativeInteger} offsetX - starting index of `X`
 * @param {Float64Array} out - array to store `alpha` and `tau`, first indexed element stores `alpha` and the second indexed element stores `tau`

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

@@ -34,10 +34,10 @@ var base = require( './base.js' );
 * -   the input vector is `[alpha; x]`, where `alpha` is a scalar and `x` is a real `(n-1)`-element vector.
 * -   the result of applying `H` to `[alpha; x]` is `[beta; 0]`, with `beta` being a scalar and the rest of the vector zeroed.
 * -   if all elements of `x` are zero, then `tau = 0` and `H` is the identity matrix.
-* -   otherwise, `1 <= tau <= 2` and `H` is orthogonal, i.e., `H^T * H = I`.
+* -   otherwise, `1 <= tau <= 2`
 *
 * @param {NonNegativeInteger} N - order of matrix `A`
-* @param {Float64Array} X - overwritten by the vector `V` on exit
+* @param {Float64Array} X - overwritten by the vector `V` on exit, expects `N - 1` indexed elements
 * @param {integer} incx - stride length for `X`
 * @param {Float64Array} out - array to store `alpha` and `tau`, first indexed element stores `alpha` and the second indexed element stores `tau`
 * @returns {void} overwrites the array `X` and `out` in place

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

@@ -27,7 +27,7 @@
 * -   the input vector is `[alpha; x]`, where `alpha` is a scalar and `x` is a real `(n-1)`-element vector.
 * -   the result of applying `H` to `[alpha; x]` is `[beta; 0]`, with `beta` being a scalar and the rest of the vector zeroed.
 * -   if all elements of `x` are zero, then `tau = 0` and `H` is the identity matrix.
-* -   otherwise, `1 <= tau <= 2` and `H` is orthogonal, i.e., `H^T * H = I`.
+* -   otherwise, `1 <= tau <= 2`
 *
 * @module @stdlib/lapack/base/dlarfg
 *

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

@@ -34,10 +34,10 @@ var base = require( './base.js' );
 * -   the input vector is `[alpha; x]`, where `alpha` is a scalar and `x` is a real `(n-1)`-element vector.
 * -   the result of applying `H` to `[alpha; x]` is `[beta; 0]`, with `beta` being a scalar and the rest of the vector zeroed.
 * -   if all elements of `x` are zero, then `tau = 0` and `H` is the identity matrix.
-* -   otherwise, `1 <= tau <= 2` and `H` is orthogonal, i.e., `H^T * H = I`.
+* -   otherwise, `1 <= tau <= 2`
 *
 * @param {NonNegativeInteger} N - order of matrix `A`
-* @param {Float64Array} X - overwritten by the vector `V` on exit
+* @param {Float64Array} X - overwritten by the vector `V` on exit, expects `N - 1` indexed elements
 * @param {integer} strideX - stride length for `X`
 * @param {NonNegativeInteger} offsetX - starting index of `X`
 * @param {Float64Array} out - array to store `alpha` and `tau`, first indexed element stores `alpha` and the second indexed element stores `tau`