Skip to content

Commit 111334e

Browse files
committed
Auto-generated commit
1 parent c3d4d43 commit 111334e

File tree

3 files changed

+11
-6
lines changed

3 files changed

+11
-6
lines changed

CHANGELOG.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
55
<section class="release" id="unreleased">
66

7-
## Unreleased (2026-01-21)
7+
## Unreleased (2026-01-24)
88

99
<section class="features">
1010

@@ -640,6 +640,10 @@
640640

641641
### BREAKING CHANGES
642642

643+
- [`45ca891`](https://github.com/stdlib-js/stdlib/commit/45ca891a86f94011ad8b407ba8cf53a7cecbb7b5): rename `with` to `ndarrayWith` in `ndarray` namespace
644+
645+
- Users should migrate to the new function name when using it directly via the namespace object.
646+
643647
- [`3c567b6`](https://github.com/stdlib-js/stdlib/commit/3c567b634cf5e5fa5e31b64f94206db5b4a88133): add `writable` parameter
644648

645649
- To migrate, users should explicitly provide a third argument indicating whether the ndarray returned by `expandDimensions` should be read-only. To preserve previous behavior, users should set the third argument to a boolean indicating whether a provided input ndarray is read-only.
@@ -709,6 +713,7 @@ A total of 42 issues were closed in this release:
709713

710714
<details>
711715

716+
- [`45ca891`](https://github.com/stdlib-js/stdlib/commit/45ca891a86f94011ad8b407ba8cf53a7cecbb7b5) - **refactor:** rename `with` alias to `ndarrayWith` in `ndarray` _(by Philipp Burckhardt)_
712717
- [`68446dc`](https://github.com/stdlib-js/stdlib/commit/68446dcb55d7b08e39baf6efae7ba5ba038c923f) - **docs:** update namespace table of contents [(#9848)](https://github.com/stdlib-js/stdlib/pull/9848) _(by stdlib-bot)_
713718
- [`be2d13e`](https://github.com/stdlib-js/stdlib/commit/be2d13ea3b0b13e51fbc9a51a0788b03d1eb3618) - **chore:** fix JavaScript lint errors [(#9796)](https://github.com/stdlib-js/stdlib/pull/9796) _(by 가은 정)_
714719
- [`eee0e09`](https://github.com/stdlib-js/stdlib/commit/eee0e097b23ead16e0933da53a9a1c40dc5b713e) - **docs:** remove extra empty line [(#9756)](https://github.com/stdlib-js/stdlib/pull/9756) _(by stdlib-bot)_

docs/types/index.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ import ndarray2array = require( './../../to-array' );
101101
import ndarray2json = require( './../../to-json' );
102102
import toReversed = require( './../../to-reversed' );
103103
import vector = require( './../../vector' );
104-
import _with = require( './../../with' );
104+
import ndarrayWith = require( './../../with' );
105105
import zeros = require( './../../zeros' );
106106
import zerosLike = require( './../../zeros-like' );
107107

@@ -2803,13 +2803,13 @@ interface Namespace {
28032803
*
28042804
* var x = ndarray( 'generic', buffer, shape, strides, offset, order );
28052805
*
2806-
* var out = ns.with( x, [ 0, 0 ], 5 );
2806+
* var out = ns.ndarrayWith( x, [ 0, 0 ], 5 );
28072807
* // returns <ndarray>
28082808
*
28092809
* var v = out.get( 0, 0 );
28102810
* // returns 5
28112811
*/
2812-
with: typeof _with;
2812+
ndarrayWith: typeof ndarrayWith;
28132813

28142814
/**
28152815
* Creates a zero-filled array having a specified shape and data type.

lib/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -775,13 +775,13 @@ setReadOnly( ns, 'toReversed', require( './../to-reversed' ) );
775775
setReadOnly( ns, 'vector', require( './../vector' ) );
776776

777777
/**
778-
* @name with
778+
* @name ndarrayWith
779779
* @memberof ns
780780
* @readonly
781781
* @type {Function}
782782
* @see {@link module:@stdlib/ndarray/with}
783783
*/
784-
setReadOnly( ns, 'with', require( './../with' ) );
784+
setReadOnly( ns, 'ndarrayWith', require( './../with' ) );
785785

786786
/**
787787
* @name zeros

0 commit comments

Comments
 (0)