docs: add sub-namespace sections and update namespace table of contents

Author: Planeshifter

lib/node_modules/@stdlib/_tools/eslint/rules/README.md

@@ -81,6 +81,7 @@ var eslint = rules;
 -   <span class="signature">[`require-globals`][@stdlib/_tools/eslint/rules/require-globals]</span><span class="delimiter">: </span><span class="description">ESLint rule enforcing that specified global variables are explicitly required.</span>
 -   <span class="signature">[`require-leading-slash`][@stdlib/_tools/eslint/rules/require-leading-slash]</span><span class="delimiter">: </span><span class="description">ESLint rule disallowing `require()` calls of relative paths which do not begin with a leading `./`.</span>
 -   <span class="signature">[`require-order`][@stdlib/_tools/eslint/rules/require-order]</span><span class="delimiter">: </span><span class="description">ESLint rule enforcing a specified order of `require()` calls.</span>
+-   <span class="signature">[`require-spaces`][@stdlib/_tools/eslint/rules/require-spaces]</span><span class="delimiter">: </span><span class="description">ESLint rule enforcing spaces in `require()` statements.</span>
 -   <span class="signature">[`section-header-empty-lines`][@stdlib/_tools/eslint/rules/section-header-empty-lines]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce that section header comments are padded by empty lines.</span>
 -   <span class="signature">[`section-headers`][@stdlib/_tools/eslint/rules/section-headers]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce formatting of section header comments.</span>
 -   <span class="signature">[`ternary-condition-parentheses`][@stdlib/_tools/eslint/rules/ternary-condition-parentheses]</span><span class="delimiter">: </span><span class="description">ESLint rule requiring parentheses around ternary conditions.</span>
@@ -421,6 +422,8 @@ console.log( getKeys( rules ) );
 
 [@stdlib/_tools/eslint/rules/require-order]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/require-order
 
+[@stdlib/_tools/eslint/rules/require-spaces]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/require-spaces
+
 [@stdlib/_tools/eslint/rules/section-header-empty-lines]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/section-header-empty-lines
 
 [@stdlib/_tools/eslint/rules/section-headers]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/section-headers

lib/node_modules/@stdlib/complex/README.md

@@ -39,10 +39,35 @@ var o = ns;
 // returns {...}
 ```
 
+The namespace contains the following sub-namespaces:
+
+<!-- <toc pattern="+(base|float32|float64)"> -->
+
+<div class="namespace-toc">
+
+-   <span class="signature">[`base`][@stdlib/complex/base]</span><span class="delimiter">: </span><span class="description">base (i.e., lower-level) complex number functions.</span>
+-   <span class="signature">[`float32`][@stdlib/complex/float32]</span><span class="delimiter">: </span><span class="description">single-precision complex floating-point number functions.</span>
+-   <span class="signature">[`float64`][@stdlib/complex/float64]</span><span class="delimiter">: </span><span class="description">double-precision complex floating-point number functions.</span>
+
+</div>
+
+<!-- </toc> -->
+
 The namespace contains the following APIs:
 
 <!-- <toc pattern="*"> -->
 
+<div class="namespace-toc">
+
+-   <span class="signature">[`complex( real, imag[, dtype] )`][@stdlib/complex/cmplx]</span><span class="delimiter">: </span><span class="description">create a complex number.</span>
+-   <span class="signature">[`ctors( dtype )`][@stdlib/complex/ctors]</span><span class="delimiter">: </span><span class="description">complex number constructors.</span>
+-   <span class="signature">[`dtype( value )`][@stdlib/complex/dtype]</span><span class="delimiter">: </span><span class="description">return the data type of a complex number.</span>
+-   <span class="signature">[`dtypes()`][@stdlib/complex/dtypes]</span><span class="delimiter">: </span><span class="description">list of complex number data types.</span>
+-   <span class="signature">[`promotionRules( [dtype1, dtype2] )`][@stdlib/complex/promotion-rules]</span><span class="delimiter">: </span><span class="description">return the complex number data type with the smallest size and closest "kind" to which data types can be **safely** cast.</span>
+-   <span class="signature">[`reviveComplex( key, value )`][@stdlib/complex/reviver]</span><span class="delimiter">: </span><span class="description">revive a JSON-serialized complex number.</span>
+
+</div>
+
 <!-- </toc> -->
 
 </section>
@@ -80,6 +105,28 @@ console.log( objectKeys( ns ) );
 
 <section class="links">
 
+<!-- <toc-links> -->
+
+[@stdlib/complex/cmplx]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/cmplx
+
+[@stdlib/complex/ctors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/ctors
+
+[@stdlib/complex/dtype]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/dtype
+
+[@stdlib/complex/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/dtypes
+
+[@stdlib/complex/promotion-rules]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/promotion-rules
+
+[@stdlib/complex/reviver]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/reviver
+
+[@stdlib/complex/base]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/base
+
+[@stdlib/complex/float32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32
+
+[@stdlib/complex/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64
+
+<!-- </toc-links> -->
+
 </section>
 
 <!-- /.links -->

lib/node_modules/@stdlib/complex/float32/README.md

@@ -39,10 +39,34 @@ var ns = complex;
 // returns {...}
 ```
 
+The namespace contains the following sub-namespaces:
+
+<!-- <toc pattern="+(base)"> -->
+
+<div class="namespace-toc">
+
+-   <span class="signature">[`base`][@stdlib/complex/float32/base]</span><span class="delimiter">: </span><span class="description">base (i.e., lower-level) single-precision complex floating-point number functions.</span>
+
+</div>
+
+<!-- </toc> -->
+
 The namespace contains the following functions:
 
 <!-- <toc pattern="*"> -->
 
+<div class="namespace-toc">
+
+-   <span class="signature">[`conj( z )`][@stdlib/complex/float32/conj]</span><span class="delimiter">: </span><span class="description">return the complex conjugate of a single-precision complex floating-point number.</span>
+-   <span class="signature">[`Complex64( real, imag )`][@stdlib/complex/float32/ctor]</span><span class="delimiter">: </span><span class="description">64-bit complex number.</span>
+-   <span class="signature">[`imag( z )`][@stdlib/complex/float32/imag]</span><span class="delimiter">: </span><span class="description">return the imaginary component of a single-precision complex floating-point number.</span>
+-   <span class="signature">[`parseComplex64( str )`][@stdlib/complex/float32/parse]</span><span class="delimiter">: </span><span class="description">parse a string representation of a 64-bit complex number.</span>
+-   <span class="signature">[`real( z )`][@stdlib/complex/float32/real]</span><span class="delimiter">: </span><span class="description">return the real component of a single-precision complex floating-point number.</span>
+-   <span class="signature">[`reim( z )`][@stdlib/complex/float32/reim]</span><span class="delimiter">: </span><span class="description">return the real and imaginary components of a single-precision complex floating-point number.</span>
+-   <span class="signature">[`reviveComplex64( key, value )`][@stdlib/complex/float32/reviver]</span><span class="delimiter">: </span><span class="description">revive a JSON-serialized 64-bit complex number.</span>
+
+</div>
+
 <!-- </toc> -->
 
 </section>
@@ -90,6 +114,22 @@ console.log( objectKeys( ns ) );
 
 <!-- <toc-links> -->
 
+[@stdlib/complex/float32/conj]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/conj
+
+[@stdlib/complex/float32/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/ctor
+
+[@stdlib/complex/float32/imag]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/imag
+
+[@stdlib/complex/float32/parse]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/parse
+
+[@stdlib/complex/float32/real]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/real
+
+[@stdlib/complex/float32/reim]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/reim
+
+[@stdlib/complex/float32/reviver]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/reviver
+
+[@stdlib/complex/float32/base]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base
+
 <!-- </toc-links> -->
 
 </section>

lib/node_modules/@stdlib/complex/float32/base/README.md

@@ -39,10 +39,29 @@ var ns = complex;
 // returns {...}
 ```
 
+The namespace contains the following sub-namespaces:
+
+<!-- <toc pattern="+(assert)"> -->
+
+<div class="namespace-toc">
+
+-   <span class="signature">[`assert`][@stdlib/complex/float32/base/assert]</span><span class="delimiter">: </span><span class="description">base (i.e., lower-level) single-precision complex floating-point number assertion functions.</span>
+
+</div>
+
+<!-- </toc> -->
+
 The namespace contains the following functions:
 
 <!-- <toc pattern="*"> -->
 
+<div class="namespace-toc">
+
+-   <span class="signature">[`add( z1, z2 )`][@stdlib/complex/float32/base/add]</span><span class="delimiter">: </span><span class="description">add two single-precision complex floating-point numbers.</span>
+-   <span class="signature">[`mul( z1, z2 )`][@stdlib/complex/float32/base/mul]</span><span class="delimiter">: </span><span class="description">multiply two single-precision complex floating-point numbers.</span>
+
+</div>
+
 <!-- </toc> -->
 
 </section>
@@ -90,6 +109,12 @@ console.log( objectKeys( ns ) );
 
 <!-- <toc-links> -->
 
+[@stdlib/complex/float32/base/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/add
+
+[@stdlib/complex/float32/base/assert]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/assert
+
+[@stdlib/complex/float32/base/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/mul
+
 <!-- </toc-links> -->
 
 </section>

lib/node_modules/@stdlib/complex/float32/base/assert/README.md

@@ -43,6 +43,15 @@ The namespace contains the following functions:
 
 <!-- <toc pattern="*"> -->
 
+<div class="namespace-toc">
+
+-   <span class="signature">[`isEqual( z1, z2 )`][@stdlib/complex/float32/base/assert/is-equal]</span><span class="delimiter">: </span><span class="description">test whether two single-precision complex floating-point numbers are equal.</span>
+-   <span class="signature">[`isNotEqual( z1, z2 )`][@stdlib/complex/float32/base/assert/is-not-equal]</span><span class="delimiter">: </span><span class="description">test whether two single-precision complex floating-point numbers are not equal.</span>
+-   <span class="signature">[`isSameValueZero( z1, z2 )`][@stdlib/complex/float32/base/assert/is-same-value-zero]</span><span class="delimiter">: </span><span class="description">test whether two single-precision complex floating-point numbers are the same value.</span>
+-   <span class="signature">[`isSameValue( z1, z2 )`][@stdlib/complex/float32/base/assert/is-same-value]</span><span class="delimiter">: </span><span class="description">test whether two single-precision complex floating-point numbers are the same value.</span>
+
+</div>
+
 <!-- </toc> -->
 
 </section>
@@ -90,6 +99,14 @@ console.log( objectKeys( ns ) );
 
 <!-- <toc-links> -->
 
+[@stdlib/complex/float32/base/assert/is-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/assert/is-equal
+
+[@stdlib/complex/float32/base/assert/is-not-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/assert/is-not-equal
+
+[@stdlib/complex/float32/base/assert/is-same-value-zero]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/assert/is-same-value-zero
+
+[@stdlib/complex/float32/base/assert/is-same-value]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/assert/is-same-value
+
 <!-- </toc-links> -->
 
 </section>

lib/node_modules/@stdlib/complex/float64/README.md

@@ -39,10 +39,34 @@ var ns = complex;
 // returns {...}
 ```
 
+The namespace contains the following sub-namespaces:
+
+<!-- <toc pattern="+(base)"> -->
+
+<div class="namespace-toc">
+
+-   <span class="signature">[`base`][@stdlib/complex/float64/base]</span><span class="delimiter">: </span><span class="description">base (i.e., lower-level) double-precision complex floating-point number functions.</span>
+
+</div>
+
+<!-- </toc> -->
+
 The namespace contains the following functions:
 
 <!-- <toc pattern="*"> -->
 
+<div class="namespace-toc">
+
+-   <span class="signature">[`conj( z )`][@stdlib/complex/float64/conj]</span><span class="delimiter">: </span><span class="description">return the complex conjugate of a double-precision complex floating-point number.</span>
+-   <span class="signature">[`Complex128( real, imag )`][@stdlib/complex/float64/ctor]</span><span class="delimiter">: </span><span class="description">128-bit complex number.</span>
+-   <span class="signature">[`imag( z )`][@stdlib/complex/float64/imag]</span><span class="delimiter">: </span><span class="description">return the imaginary component of a double-precision complex floating-point number.</span>
+-   <span class="signature">[`parseComplex128( str )`][@stdlib/complex/float64/parse]</span><span class="delimiter">: </span><span class="description">parse a string representation of a 128-bit complex number.</span>
+-   <span class="signature">[`real( z )`][@stdlib/complex/float64/real]</span><span class="delimiter">: </span><span class="description">return the real component of a double-precision complex floating-point number.</span>
+-   <span class="signature">[`reim( z )`][@stdlib/complex/float64/reim]</span><span class="delimiter">: </span><span class="description">return the real and imaginary components of a double-precision complex floating-point number.</span>
+-   <span class="signature">[`reviveComplex128( key, value )`][@stdlib/complex/float64/reviver]</span><span class="delimiter">: </span><span class="description">revive a JSON-serialized 128-bit complex number.</span>
+
+</div>
+
 <!-- </toc> -->
 
 </section>
@@ -90,6 +114,22 @@ console.log( objectKeys( ns ) );
 
 <!-- <toc-links> -->
 
+[@stdlib/complex/float64/conj]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/conj
+
+[@stdlib/complex/float64/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/ctor
+
+[@stdlib/complex/float64/imag]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/imag
+
+[@stdlib/complex/float64/parse]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/parse
+
+[@stdlib/complex/float64/real]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/real
+
+[@stdlib/complex/float64/reim]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/reim
+
+[@stdlib/complex/float64/reviver]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/reviver
+
+[@stdlib/complex/float64/base]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base
+
 <!-- </toc-links> -->
 
 </section>

lib/node_modules/@stdlib/complex/float64/base/README.md

@@ -39,10 +39,29 @@ var ns = complex;
 // returns {...}
 ```
 
+The namespace contains the following sub-namespaces:
+
+<!-- <toc pattern="+(assert)"> -->
+
+<div class="namespace-toc">
+
+-   <span class="signature">[`assert`][@stdlib/complex/float64/base/assert]</span><span class="delimiter">: </span><span class="description">base (i.e., lower-level) double-precision complex floating-point number assertion functions.</span>
+
+</div>
+
+<!-- </toc> -->
+
 The namespace contains the following functions:
 
 <!-- <toc pattern="*"> -->
 
+<div class="namespace-toc">
+
+-   <span class="signature">[`add( z1, z2 )`][@stdlib/complex/float64/base/add]</span><span class="delimiter">: </span><span class="description">add two double-precision complex floating-point numbers.</span>
+-   <span class="signature">[`mul( z1, z2 )`][@stdlib/complex/float64/base/mul]</span><span class="delimiter">: </span><span class="description">multiply two double-precision complex floating-point numbers.</span>
+
+</div>
+
 <!-- </toc> -->
 
 </section>
@@ -90,6 +109,12 @@ console.log( objectKeys( ns ) );
 
 <!-- <toc-links> -->
 
+[@stdlib/complex/float64/base/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/add
+
+[@stdlib/complex/float64/base/assert]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/assert
+
+[@stdlib/complex/float64/base/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/mul
+
 <!-- </toc-links> -->
 
 </section>

lib/node_modules/@stdlib/complex/float64/base/assert/README.md

@@ -43,6 +43,15 @@ The namespace contains the following functions:
 
 <!-- <toc pattern="*"> -->
 
+<div class="namespace-toc">
+
+-   <span class="signature">[`isEqual( z1, z2 )`][@stdlib/complex/float64/base/assert/is-equal]</span><span class="delimiter">: </span><span class="description">test whether two double-precision complex floating-point numbers are equal.</span>
+-   <span class="signature">[`isNotEqual( z1, z2 )`][@stdlib/complex/float64/base/assert/is-not-equal]</span><span class="delimiter">: </span><span class="description">test whether two double-precision complex floating-point numbers are not equal.</span>
+-   <span class="signature">[`isSameValueZero( z1, z2 )`][@stdlib/complex/float64/base/assert/is-same-value-zero]</span><span class="delimiter">: </span><span class="description">test whether two double-precision complex floating-point numbers are the same value.</span>
+-   <span class="signature">[`isSameValue( z1, z2 )`][@stdlib/complex/float64/base/assert/is-same-value]</span><span class="delimiter">: </span><span class="description">test whether two double-precision complex floating-point numbers are the same value.</span>
+
+</div>
+
 <!-- </toc> -->
 
 </section>
@@ -90,6 +99,14 @@ console.log( objectKeys( ns ) );
 
 <!-- <toc-links> -->
 
+[@stdlib/complex/float64/base/assert/is-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/assert/is-equal
+
+[@stdlib/complex/float64/base/assert/is-not-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/assert/is-not-equal
+
+[@stdlib/complex/float64/base/assert/is-same-value-zero]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/assert/is-same-value-zero
+
+[@stdlib/complex/float64/base/assert/is-same-value]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/assert/is-same-value
+
 <!-- </toc-links> -->
 
 </section>