Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Feb 1, 2024
1 parent c74b3b9 commit 02e35de
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 13 deletions.
2 changes: 1 addition & 1 deletion .github/.keepalive
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2024-01-01T04:02:57.458Z
2024-02-01T04:50:04.896Z
2 changes: 1 addition & 1 deletion NOTICE
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Copyright (c) 2016-2023 The Stdlib Authors.
Copyright (c) 2016-2024 The Stdlib Authors.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

</section>

<section class="usage">
Expand Down Expand Up @@ -315,8 +317,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/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
Expand Down
11 changes: 7 additions & 4 deletions branches.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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
[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
8 changes: 4 additions & 4 deletions docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 ]
Expand All @@ -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 );
*
Expand All @@ -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 ]
Expand Down

0 comments on commit 02e35de

Please sign in to comment.