Skip to content

Commit 2c6dbb1

Browse files
committed
Auto-generated commit
1 parent 5e60917 commit 2c6dbb1

5 files changed

Lines changed: 14 additions & 13 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@
5151

5252
<details>
5353

54+
- [`3adbe8a`](https://github.com/stdlib-js/stdlib/commit/3adbe8a17ba4a8ac59a6dbb66085ee84cb78d35d) - **docs:** propagate fixes to sibling packages [(#13133)](https://github.com/stdlib-js/stdlib/pull/13133) _(by Philipp Burckhardt)_
5455
- [`92b5eb4`](https://github.com/stdlib-js/stdlib/commit/92b5eb479a9ba6d3fe4f722d2f1b47e61a03122c) - **fix:** use correct argument during error message interpolation and update descriptions [(#13105)](https://github.com/stdlib-js/stdlib/pull/13105) _(by Philipp Burckhardt)_
5556
- [`1977f92`](https://github.com/stdlib-js/stdlib/commit/1977f92944b56c40c27b23d74570f2958adc7a39) - **docs:** update documented default value for `submode` option [(#13106)](https://github.com/stdlib-js/stdlib/pull/13106) _(by Philipp Burckhardt)_
5657
- [`e6cc42b`](https://github.com/stdlib-js/stdlib/commit/e6cc42bab0268753252236d0e7511c97443754cc) - **fix:** correct typo in enum name and fix C examples [(#13088)](https://github.com/stdlib-js/stdlib/pull/13088) _(by anee3)_

array/docs/types/index.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ interface Options {
4343
mode?: Mode;
4444

4545
/**
46-
* Specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: ['throw']).
46+
* Specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: [options.mode]).
4747
*/
4848
submode?: Array<string>;
4949

@@ -139,7 +139,7 @@ interface ExtendedOptions extends Options {
139139
* @param options.order - specifies the memory layout of the array as either row-major (C-style) or column-major (Fortran-style) (default: 'row-major')
140140
* @param options.shape - array shape
141141
* @param options.mode - specifies how to handle indices which exceed array dimensions (default: 'throw')
142-
* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: ['throw'])
142+
* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: [options.mode])
143143
* @param options.copy - boolean indicating whether to copy source data to a new data buffer (default: false)
144144
* @param options.flatten - boolean indicating whether to automatically flatten generic array data sources (default: true)
145145
* @param options.ndmin - minimum number of dimensions (default: 0)
@@ -176,7 +176,7 @@ declare function array<T = unknown>( options: OptionsWithShape | OptionsWithBuff
176176
* @param options.order - specifies the memory layout of the array as either row-major (C-style) or column-major (Fortran-style) (default: 'row-major')
177177
* @param options.shape - array shape
178178
* @param options.mode - specifies how to handle indices which exceed array dimensions (default: 'throw')
179-
* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: ['throw'])
179+
* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: [options.mode])
180180
* @param options.copy - boolean indicating whether to copy source data to a new data buffer (default: false)
181181
* @param options.flatten - boolean indicating whether to automatically flatten generic array data sources (default: true)
182182
* @param options.ndmin - minimum number of dimensions (default: 0)

ctor/docs/types/index.d.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ interface Options {
3434
mode?: Mode;
3535

3636
/**
37-
* Specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: ['throw']).
37+
* Specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: [options.mode]).
3838
*/
3939
submode?: ArrayLike<Mode>;
4040

@@ -59,7 +59,7 @@ interface Constructor {
5959
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
6060
* @param options - function options
6161
* @param options.mode - specifies how to handle indices which exceed array dimensions (default: 'throw')
62-
* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: ['throw'])
62+
* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: [options.mode])
6363
* @param options.readonly - specifies whether an array should be read-only (default: false)
6464
* @throws `buffer` argument `get` and `set` properties must be functions
6565
* @throws `shape` argument must be an array-like object containing nonnegative integers
@@ -94,7 +94,7 @@ interface Constructor {
9494
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
9595
* @param options - function options
9696
* @param options.mode - specifies how to handle indices which exceed array dimensions (default: 'throw')
97-
* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: ['throw'])
97+
* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: [options.mode])
9898
* @param options.readonly - specifies whether an array should be read-only (default: false)
9999
* @throws `buffer` argument `get` and `set` properties must be functions
100100
* @throws `shape` argument must be an array-like object containing nonnegative integers
@@ -130,7 +130,7 @@ interface Constructor {
130130
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
131131
* @param options - function options
132132
* @param options.mode - specifies how to handle indices which exceed array dimensions (default: 'throw')
133-
* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: ['throw'])
133+
* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: [options.mode])
134134
* @param options.readonly - specifies whether an array should be read-only (default: false)
135135
* @throws `buffer` argument `get` and `set` properties must be functions
136136
* @throws `shape` argument must be an array-like object containing nonnegative integers

docs/types/index.d.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ interface Namespace {
305305
* @param options.order - specifies the memory layout of the array as either row-major (C-style) or column-major (Fortran-style) (default: 'row-major')
306306
* @param options.shape - array shape
307307
* @param options.mode - specifies how to handle indices which exceed array dimensions (default: 'throw')
308-
* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: ['throw'])
308+
* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: [options.mode])
309309
* @param options.copy - boolean indicating whether to copy source data to a new data buffer (default: false)
310310
* @param options.flatten - boolean indicating whether to automatically flatten generic array data sources (default: true)
311311
* @param options.ndmin - minimum number of dimensions (default: 0)
@@ -945,7 +945,7 @@ interface Namespace {
945945
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
946946
* @param options - function options
947947
* @param options.mode - specifies how to handle indices which exceed array dimensions (default: 'throw')
948-
* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: ['throw'])
948+
* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: [options.mode])
949949
* @param options.readonly - specifies whether an array should be read-only (default: false)
950950
* @throws `buffer` argument `get` and `set` properties must be functions
951951
* @throws `shape` argument must be an array-like object containing nonnegative integers
@@ -1405,7 +1405,7 @@ interface Namespace {
14051405
* @param order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
14061406
* @param options - function options
14071407
* @param options.mode - specifies how to handle indices which exceed array dimensions (default: 'throw')
1408-
* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: ['throw'])
1408+
* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: [options.mode])
14091409
* @param options.readonly - specifies whether an array should be read-only (default: false)
14101410
* @throws `buffer` argument `get` and `set` properties must be functions
14111411
* @throws `shape` argument must be an array-like object containing nonnegative integers
@@ -2580,7 +2580,7 @@ interface Namespace {
25802580
* @param x - input ndarray
25812581
* @param options - function options
25822582
* @param options.mode - specifies how to handle indices which exceed array dimensions (default: 'throw')
2583-
* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: ['throw'])
2583+
* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: [options.mode])
25842584
* @param options.readonly - specifies whether an array should be read-only
25852585
* @returns ndarray
25862586
*

ndarraylike2ndarray/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ interface Options {
3333
mode?: Mode;
3434

3535
/**
36-
* Specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: ['throw']).
36+
* Specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: [options.mode]).
3737
*/
3838
submode?: ArrayLike<Mode>;
3939

@@ -53,7 +53,7 @@ interface Options {
5353
* @param x - input ndarray
5454
* @param options - function options
5555
* @param options.mode - specifies how to handle indices which exceed array dimensions (default: 'throw')
56-
* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: ['throw'])
56+
* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: [options.mode])
5757
* @param options.readonly - specifies whether an array should be read-only
5858
* @returns ndarray
5959
*

0 commit comments

Comments
 (0)