8000 Auto-generated commit · stdlib-js/slice-base-shape@4089c59 · GitHub
[go: up one dir, main page]
Skip to content 8000

Commit 4089c59

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent 56ef2c6 commit 4089c59

File tree

5 files changed

+26
-18
lines changed

5 files changed

+26
-18
lines changed

‎.github/.keepalive

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2024-01-01T03:14:30.378Z
1+
2024-02-01T03:53:41.530Z

‎NOTICE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Copyright (c) 2016-2023 The Stdlib Authors.
1+
Copyright (c) 2016-2024 The Stdlib Authors.

‎README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,14 @@ npm install @stdlib/slice-base-shape
5555

5656
Alternatively,
5757

58-
- 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].
59-
- If you are using Deno, visit the [`deno` branch][deno-url].
60-
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd` branch][umd-url].
58+
- 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]).
59+
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
60+
- 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]).
6161

6262
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
6363

64+
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.
65+
6466
</section>
6567

6668
<section class="usage">
@@ -241,8 +243,11 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
241243
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
242244

243245
[deno-url]: https://github.com/stdlib-js/slice-base-shape/tree/deno
246+
[deno-readme]: https://github.com/stdlib-js/slice-base-shape/blob/deno/README.md
244247
[umd-url]: https://github.com/stdlib-js/slice-base-shape/tree/umd
248+
[umd-readme]: https://github.com/stdlib-js/slice-base-shape/blob/umd/README.md
245249
[esm-url]: https://github.com/stdlib-js/slice-base-shape/tree/esm
250+
[esm-readme]: https://github.com/stdlib-js/slice-base-shape/blob/esm/README.md
246251
[branches-url]: https://github.com/stdlib-js/slice-base-shape/blob/main/branches.md
247252

248253
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/slice-base-shape/main/LICENSE

‎branches.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ This repository has the following branches:
2424

2525
- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place.
2626
- **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).
27-
- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers.
28-
- **deno**: [Deno][deno-url] branch for use in Deno.
29-
- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments.
27+
- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]).
28+
- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]).
29+
- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]).
3030

3131
The following diagram illustrates the relationships among the above branches:
3232

@@ -49,5 +49,8 @@ C -->|bundle| F[umd];
4949
[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/slice/base/shape
5050
[production-url]: https://github.com/stdlib-js/slice-base-shape/tree/production
5151
[deno-url]: https://github.com/stdlib-js/slice-base-shape/tree/deno
52+
[deno-readme]: https://github.com/stdlib-js/slice-base-shape/blob/deno/README.md
5253
[umd-url]: https://github.com/stdlib-js/slice-base-shape/tree/umd
53-
[esm-url]: https://github.com/stdlib-js/slice-base-shape/tree/esm
54+
[umd-readme]: https://github.com/stdlib-js/slice-base-shape/blob/umd/README.md
55+
[esm-url]: https://github.com/stdlib-js/slice-base-shape/tree/esm
56+
[esm-readme]: https://github.com/stdlib-js/slice-base-shape/blob/esm/README.md

‎docs/types/index.d.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ import { MultiSlice } from '@stdlib/types/slice';
2929
* @returns slice shape
3030
*
3131
* @example
32-
* var Slice = require( `@stdlib/slice/ctor` );
33-
* var MultiSlice = require( `@stdlib/slice/multi` );
34-
* var normalizeMultiSlice = require( `@stdlib/slice/base/normalize-multi-slice` );
32+
* var Slice = require( '@stdlib/slice-ctor' );
33+
* var MultiSlice = require( '@stdlib/slice-multi' );
34+
* var normalizeMultiSlice = require( '@stdlib/slice-base-normalize-multi-slice' );
3535
*
3636
* var s = new MultiSlice( new Slice( 2, null, 1 ), null, 10 );
3737
*
@@ -45,9 +45,9 @@ import { MultiSlice } from '@stdlib/types/slice';
4545
* // returns [ 3, 10, 1 ]
4646
*
4747
* @example
48-
* var Slice = require( `@stdlib/slice/ctor` );
49-
* var MultiSlice = require( `@stdlib/slice/multi` );
50-
* var normalizeMultiSlice = require( `@stdlib/slice/base/normalize-multi-slice` );
48+
* var Slice = require( '@stdlib/slice-ctor' );
49+
* var MultiSlice = require( '@stdlib/slice-multi' );
50+
* var normalizeMultiSlice = require( '@stdlib/slice-base-normalize-multi-slice' );
5151
*
5252
* var s = new MultiSlice( null, new Slice( -1, 3, -2 ) );
5353
*
@@ -61,9 +61,9 @@ import { MultiSlice } from '@stdlib/types/slice';
6161
* // returns [ 5, 6 ]
6262
*
6363
* @example
64-
* var Slice = require( `@stdlib/slice/ctor` );
65-
* var MultiSlice = require( `@stdlib/slice/multi` );
66-
* var normalizeMultiSlice = require( `@stdlib/slice/base/normalize-multi-slice` );
64+
* var Slice = require( '@stdlib/slice-ctor' );
65+
* var MultiSlice = require( '@stdlib/slice-multi' );
66+
* var normalizeMultiSlice = require( '@stdlib/slice-base-normalize-multi-slice' );
6767
*
6868
* var s = new MultiSlice( 1, new Slice( 0, 0, 1 ) );
6969
*

0 commit comments

Comments
 (0)
0