Auto-generated commit

Author: stdlib-bot

README.md

@@ -45,12 +45,14 @@ npm install @stdlib/complex
 
 Alternatively,
 
--   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm` branch][esm-url].
--   If you are using Deno, visit the [`deno` branch][deno-url].
--   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd` branch][umd-url].
+-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
+-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
+-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
 
 The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
 
+To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
+
 </section>
 
 <section class="usage">
@@ -229,8 +231,11 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
 
 [deno-url]: https://github.com/stdlib-js/complex/tree/deno
+[deno-readme]: https://github.com/stdlib-js/complex/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/complex/tree/umd
+[umd-readme]: https://github.com/stdlib-js/complex/blob/umd/README.md
 [esm-url]: https://github.com/stdlib-js/complex/tree/esm
+[esm-readme]: https://github.com/stdlib-js/complex/blob/esm/README.md
 [branches-url]: https://github.com/stdlib-js/complex/blob/main/branches.md
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/complex/main/LICENSE

base/README.md

@@ -45,6 +45,7 @@ The namespace contains the following functions:
 
 <div class="namespace-toc">
 
+-   <span class="signature">[`assert`][@stdlib/complex/base/assert]</span><span class="delimiter">: </span><span class="description">base complex number assert functions.</span>
 -   <span class="signature">[`cast( fcn, nargs, ctor )`][@stdlib/complex/base/cast-return]</span><span class="delimiter">: </span><span class="description">wrap a function and cast a function's return value to a complex number.</span>
 -   <span class="signature">[`wrap( fcn, nargs, ctor )`][@stdlib/complex/base/wrap-function]</span><span class="delimiter">: </span><span class="description">wrap a function accepting complex number arguments to support providing both real and complex numbers.</span>
 
@@ -97,6 +98,8 @@ console.log( objectKeys( ns ) );
 
 <!-- <toc-links> -->
 
+[@stdlib/complex/base/assert]: https://github.com/stdlib-js/complex/tree/main/base/assert
+
 [@stdlib/complex/base/cast-return]: https://github.com/stdlib-js/complex/tree/main/base/cast-return
 
 [@stdlib/complex/base/wrap-function]: https://github.com/stdlib-js/complex/tree/main/base/wrap-function

base/assert/README.md

@@ -43,6 +43,19 @@ The namespace contains the following functions:
 
 <!-- <toc pattern="*"> -->
 
+<div class="namespace-toc">
+
+-   <span class="signature">[`isEqual( z1, z2 )`][@stdlib/complex/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">[`isEqualf( z1, z2 )`][@stdlib/complex/base/assert/is-equalf]</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/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">[`isNotEqualf( z1, z2 )`][@stdlib/complex/base/assert/is-not-equalf]</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/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">[`isSameValueZerof( z1, z2 )`][@stdlib/complex/base/assert/is-same-value-zerof]</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/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>
+-   <span class="signature">[`isSameValuef( z1, z2 )`][@stdlib/complex/base/assert/is-same-valuef]</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 +103,22 @@ console.log( objectKeys( ns ) );
 
 <!-- <toc-links> -->
 
+[@stdlib/complex/base/assert/is-equal]: https://github.com/stdlib-js/complex/tree/main/base/assert/is-equal
+
+[@stdlib/complex/base/assert/is-equalf]: https://github.com/stdlib-js/complex/tree/main/base/assert/is-equalf
+
+[@stdlib/complex/base/assert/is-not-equal]: https://github.com/stdlib-js/complex/tree/main/base/assert/is-not-equal
+
+[@stdlib/complex/base/assert/is-not-equalf]: https://github.com/stdlib-js/complex/tree/main/base/assert/is-not-equalf
+
+[@stdlib/complex/base/assert/is-same-value-zero]: https://github.com/stdlib-js/complex/tree/main/base/assert/is-same-value-zero
+
+[@stdlib/complex/base/assert/is-same-value-zerof]: https://github.com/stdlib-js/complex/tree/main/base/assert/is-same-value-zerof
+
+[@stdlib/complex/base/assert/is-same-value]: https://github.com/stdlib-js/complex/tree/main/base/assert/is-same-value
+
+[@stdlib/complex/base/assert/is-same-valuef]: https://github.com/stdlib-js/complex/tree/main/base/assert/is-same-valuef
+
 <!-- </toc-links> -->
 
 </section>

branches.md

@@ -24,9 +24,9 @@ This repository has the following branches:
 
 -   **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place.
 -   **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network).
--   **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers.
--   **deno**: [Deno][deno-url] branch for use in Deno.
--   **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments.
+-   **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]).
+-   **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]).
+-   **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]).
 
 The following diagram illustrates the relationships among the above branches:
 
@@ -49,5 +49,8 @@ C -->|bundle| F[umd];
 [stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex
 [production-url]: https://github.com/stdlib-js/complex/tree/production
 [deno-url]: https://github.com/stdlib-js/complex/tree/deno
+[deno-readme]: https://github.com/stdlib-js/complex/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/complex/tree/umd
-[esm-url]: https://github.com/stdlib-js/complex/tree/esm
+[umd-readme]: https://github.com/stdlib-js/complex/blob/umd/README.md
+[esm-url]: https://github.com/stdlib-js/complex/tree/esm
+[esm-readme]: https://github.com/stdlib-js/complex/blob/esm/README.md