Skip to content

Commit f8c931f

Browse files
committed
Auto-generated commit
1 parent 32dc5c3 commit f8c931f

2 files changed

Lines changed: 4 additions & 3 deletions

File tree

CHANGELOG.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@
3333

3434
<details>
3535

36-
- [`d01cc15`](https://github.com/stdlib-js/stdlib/commit/d01cc150c5d271c5132af9706f86fd15160e5f39) - **docs:** update `ndarray` TypeScript declarations [(#12662)](https://github.com/stdlib-js/stdlib/pull/12662) _(by stdlib-bot)_
3736
- [`69a4924`](https://github.com/stdlib-js/stdlib/commit/69a49243032c5e1a845cba2f895c835a49368b77) - **docs:** update `ndarray/iter` TypeScript declarations [(#12661)](https://github.com/stdlib-js/stdlib/pull/12661) _(by stdlib-bot)_
3837
- [`02ceb9e`](https://github.com/stdlib-js/stdlib/commit/02ceb9ef7c4b0b987a79f07daa750ea9c18f3159) - **docs:** update `ndarray/base` TypeScript declarations [(#12660)](https://github.com/stdlib-js/stdlib/pull/12660) _(by stdlib-bot)_
3938
- [`cd863cf`](https://github.com/stdlib-js/stdlib/commit/cd863cfcc93259fc77714263c6c8b532c84563a3) - **docs:** propagate recent develop fixes to sibling packages [(#12642)](https://github.com/stdlib-js/stdlib/pull/12642) _(by Philipp Burckhardt)_

docs/types/index.d.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ interface Namespace {
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)
312312
* @param options.casting - casting rule used to determine what constitutes an acceptable cast (default: 'safe')
313-
* @param options.readonly - boolean indicating whether an array should be read-only (default: false)
313+
* @param options.readonly - boolean indicating whether an array should be read-only
314314
* @throws must provide valid options
315315
* @throws must provide either an array shape, data source, or both
316316
* @throws invalid cast
@@ -680,6 +680,7 @@ interface Namespace {
680680
*
681681
* @example
682682
* var array = require( './../../array' );
683+
* var ndarray2array = require( './../../to-array' );
683684
*
684685
* var x = array( [ -1.0, 2.0, 3.0, 4.0 ] );
685686
* var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );
@@ -690,6 +691,7 @@ interface Namespace {
690691
* @example
691692
* var array = require( './../../array' );
692693
* var empty = require( './../../empty' );
694+
* var ndarray2array = require( './../../to-array' );
693695
*
694696
* var x = array( [ -1.0, 2.0, 3.0, 4.0 ] );
695697
* var y = array( [ -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ] );
@@ -2411,7 +2413,7 @@ interface Namespace {
24112413
*
24122414
* ## Notes
24132415
*
2414-
* - The function throws an error if provided broadcast-incompatible ndarrays.
2416+
* - The function throws an error if a provided broadcast-incompatible ndarrays.
24152417
* - If a provided ndarray has a shape matching the common shape, the function returns the provided ndarray.
24162418
* - If a provided ndarray has a different (broadcast compatible) shape than the common shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to a view may affect multiple elements. If you need to write to an input array, copy the array before broadcasting.
24172419
*

0 commit comments

Comments
 (0)