From 02e35defba5c6386a21b80d016061f11fb91bafa Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Feb 2024 04:50:08 +0000 Subject: [PATCH] Auto-generated commit --- .github/.keepalive | 2 +- NOTICE | 2 +- README.md | 11 ++++++++--- branches.md | 11 +++++++---- docs/types/index.d.ts | 8 ++++---- 5 files changed, 21 insertions(+), 13 deletions(-) diff --git a/.github/.keepalive b/.github/.keepalive index d7ca12a..ab2d7d8 100644 --- a/.github/.keepalive +++ b/.github/.keepalive @@ -1 +1 @@ -2024-01-01T04:02:57.458Z +2024-02-01T04:50:04.896Z diff --git a/NOTICE b/NOTICE index f7aca1b..e6e7482 100644 --- a/NOTICE +++ b/NOTICE @@ -1 +1 @@ -Copyright (c) 2016-2023 The Stdlib Authors. +Copyright (c) 2016-2024 The Stdlib Authors. diff --git a/README.md b/README.md index 923f155..fc8e80d 100644 --- a/README.md +++ b/README.md @@ -51,12 +51,14 @@ npm install @stdlib/math-base-special-cpolar 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. +
@@ -315,8 +317,11 @@ Copyright © 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/math-base-special-cpolar/tree/deno +[deno-readme]: https://github.com/stdlib-js/math-base-special-cpolar/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/math-base-special-cpolar/tree/umd +[umd-readme]: https://github.com/stdlib-js/math-base-special-cpolar/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/math-base-special-cpolar/tree/esm +[esm-readme]: https://github.com/stdlib-js/math-base-special-cpolar/blob/esm/README.md [branches-url]: https://github.com/stdlib-js/math-base-special-cpolar/blob/main/branches.md [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-cpolar/main/LICENSE diff --git a/branches.md b/branches.md index 9147853..0b4f8ec 100644 --- a/branches.md +++ b/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/math/base/special/cpolar [production-url]: https://github.com/stdlib-js/math-base-special-cpolar/tree/production [deno-url]: https://github.com/stdlib-js/math-base-special-cpolar/tree/deno +[deno-readme]: https://github.com/stdlib-js/math-base-special-cpolar/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/math-base-special-cpolar/tree/umd -[esm-url]: https://github.com/stdlib-js/math-base-special-cpolar/tree/esm \ No newline at end of file +[umd-readme]: https://github.com/stdlib-js/math-base-special-cpolar/blob/umd/README.md +[esm-url]: https://github.com/stdlib-js/math-base-special-cpolar/tree/esm +[esm-readme]: https://github.com/stdlib-js/math-base-special-cpolar/blob/esm/README.md \ No newline at end of file diff --git a/docs/types/index.d.ts b/docs/types/index.d.ts index 181b498..5a4a680 100644 --- a/docs/types/index.d.ts +++ b/docs/types/index.d.ts @@ -34,7 +34,7 @@ interface Cpolar { * @returns absolute value and phase, respectively * * @example - * var Complex128 = require( `@stdlib/complex/float64` ); + * var Complex128 = require( '@stdlib/complex-float64' ); * * var v = cpolar( new Complex128( 5.0, 3.0 ) ); * // returns [ ~5.83, ~0.5404 ] @@ -51,8 +51,8 @@ interface Cpolar { * @returns output array * * @example - * var Complex128 = require( `@stdlib/complex/float64` ); - * var Float64Array = require( `@stdlib/array/float64` ); + * var Complex128 = require( '@stdlib/complex-float64' ); + * var Float64Array = require( '@stdlib/array-float64' ); * * var out = new Float64Array( 2 ); * @@ -72,7 +72,7 @@ interface Cpolar { * @returns absolute value and phase, respectively * * @example -* var Complex128 = require( `@stdlib/complex/float64` ); +* var Complex128 = require( '@stdlib/complex-float64' ); * * var v = cpolar( new Complex128( 5.0, 3.0 ) ); * // returns [ ~5.83, ~0.5404 ]