docs: update docs and formatting

---
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: kgryte

lib/node_modules/@stdlib/fft/base/fftpack/lib/c1_ref.js

@@ -61,18 +61,18 @@
 // MAIN //
 
 /**
-* Performs a pass of the FFT algorithm.
+* Computes an index into the intermediate array `c1`.
 *
 * @private
-* @param {number} a1 - index of first dimension
-* @param {number} a2 - index of second dimension
-* @param {number} a3 - index of third dimension
-* @param {number} l1 - length parameter related to the FFT stage
-* @param {number} ido - dimension order
-* @returns {number} - calculated index
+* @param {NonNegativeInteger} a1 - index of first dimension
+* @param {NonNegativeInteger} a2 - index of second dimension
+* @param {NonNegativeInteger} a3 - index of third dimension
+* @param {NonNegativeInteger} l1 - length parameter related to the FFT stage
+* @param {NonNegativeInteger} ido - dimension order
+* @returns {NonNegativeInteger} computed index
 */
 function c1Ref( a1, a2, a3, l1, ido ) {
-	return ( ( ( a3 * l1 ) + a2 ) * ido ) + a1;
+	return ( ( (a3*l1)+a2 ) * ido ) + a1;
 }
 
 

lib/node_modules/@stdlib/fft/base/fftpack/lib/c2_ref.js

@@ -61,16 +61,16 @@
 // MAIN //
 
 /**
-* Performs a pass of the FFT algorithm.
+* Computes an index into the intermediate array `c2`.
 *
 * @private
-* @param {number} a1 - index of first dimension
-* @param {number} a2 - index of second dimension
-* @param {number} idl1 - stride related to the `l1` parameter
-* @returns {number} - calculated index
+* @param {NonNegativeInteger} a1 - index of first dimension
+* @param {NonNegativeInteger} a2 - index of second dimension
+* @param {integer} idl1 - stride related to the `l1` parameter
+* @returns {NonNegativeInteger} computed index
 */
 function c2Ref( a1, a2, idl1 ) {
-	return ( a2 * idl1 ) + a1;
+	return ( a2*idl1 ) + a1;
 }
 
 

lib/node_modules/@stdlib/fft/base/fftpack/lib/cc_ref.js

@@ -61,18 +61,18 @@
 // MAIN //
 
 /**
-* Performs a pass of the FFT algorithm.
+* Computes an index into an input array `cc` containing complex-valued data.
 *
 * @private
-* @param {number} a1 - index of first dimension
-* @param {number} a2 - index of second dimension
-* @param {number} a3 - index of third dimension
-* @param {number} ip - number of sub-steps or prime factors in the FFT
-* @param {number} ido - dimension order
-* @returns {number} - calculated index
+* @param {NonNegativeInteger} a1 - index of first dimension
+* @param {NonNegativeInteger} a2 - index of second dimension
+* @param {NonNegativeInteger} a3 - index of third dimension
+* @param {NonNegativeInteger} ip - number of sub-steps or prime factors in the FFT
+* @param {NonNegativeInteger} ido - dimension order
+* @returns {NonNegativeInteger} computed index
 */
 function ccRef( a1, a2, a3, ip, ido ) {
-	return ( ( ( a3 * ip ) + a2 ) * ido ) + a1;
+	return ( ( (a3*ip)+a2 ) * ido ) + a1;
 }
 
 

lib/node_modules/@stdlib/fft/base/fftpack/lib/ch2_ref.js

@@ -61,16 +61,16 @@
 // MAIN //
 
 /**
-* Performs a pass of the FFT algorithm.
+* Computes an index into an output array `ch2` for storing processed FFT data.
 *
 * @private
-* @param {number} a1 - index of first dimension
-* @param {number} a2 - index of second dimension
-* @param {number} idl1 - stride related to the `l1` parameter
-* @returns {number} - calculated index
+* @param {NonNegativeInteger} a1 - index of first dimension
+* @param {NonNegativeInteger} a2 - index of second dimension
+* @param {integer} idl1 - stride related to the `l1` parameter
+* @returns {NonNegativeInteger} computed index
 */
 function ch2Ref( a1, a2, idl1 ) {
-	return ( a2 * idl1 ) + a1;
+	return ( a2*idl1 ) + a1;
 }
 
 

lib/node_modules/@stdlib/fft/base/fftpack/lib/ch_ref.js

@@ -61,18 +61,18 @@
 // MAIN //
 
 /**
-* Performs a pass of the FFT algorithm.
+* Computes an index into an output array `ch` for storing processed FFT data.
 *
 * @private
-* @param {number} a1 - index of first dimension
-* @param {number} a2 - index of second dimension
-* @param {number} a3 - index of third dimension
-* @param {number} l1 - length parameter related to the FFT stage
-* @param {number} ido - dimension order
-* @returns {number} - calculated index
+* @param {NonNegativeInteger} a1 - index of first dimension
+* @param {NonNegativeInteger} a2 - index of second dimension
+* @param {NonNegativeInteger} a3 - index of third dimension
+* @param {NonNegativeInteger} l1 - length parameter related to the FFT stage
+* @param {NonNegativeInteger} ido - dimension order
+* @returns {NonNegativeInteger} - calculated index
 */
 function chRef( a1, a2, a3, l1, ido ) {
-	return ( ( ( a3 * l1 ) + a2 ) * ido ) + a1;
+	return ( ( (a3*l1)+a2 ) * ido ) + a1;
 }