Skip to content

Commit ea52864

Browse files
committed
Auto-generated commit
1 parent f49425a commit ea52864

2 files changed

Lines changed: 4 additions & 3 deletions

File tree

CHANGELOG.md

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

1313
<details>
1414

15+
- [`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)_
1516
- [`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)_
1617
- [`3116666`](https://github.com/stdlib-js/stdlib/commit/3116666b3e530b2e6fb161924ae4c43cdf02905b) - **docs:** correct TSDoc across `ndarray` TypeScript declarations [(#12635)](https://github.com/stdlib-js/stdlib/pull/12635) _(by Philipp Burckhardt, Athan Reines)_
1718
- [`c34c46b`](https://github.com/stdlib-js/stdlib/commit/c34c46b17469f73663378429eca8dba95dbf1dcd) - **bench:** refactor to use string interpolation in `ndarray/array` [(#10193)](https://github.com/stdlib-js/stdlib/pull/10193) _(by Shubham)_

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)

0 commit comments

Comments
 (0)