Skip to content

Commit 8405073

Browse files
authored
add unmerged changelog entry to release notes (#3248)
1 parent 5e8b02a commit 8405073

File tree

2 files changed

+18
-19
lines changed

2 files changed

+18
-19
lines changed

changes/2819.chore.rst

Lines changed: 0 additions & 18 deletions
This file was deleted.

docs/release-notes.rst

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,24 @@ Release notes
88

99
Features
1010
~~~~~~~~
11-
11+
- Ensure that invocations of ``create_array`` use consistent keyword arguments, with consistent defaults.
12+
13+
``zarr.api.synchronous.create_array`` now takes a ``write_data`` keyword argument
14+
The ``Group.create_array`` method takes ``data`` and ``write_data`` keyword arguments.
15+
The functions ``api.asynchronous.create``, ``api.asynchronous.create_array``
16+
and the methods ``Group.create_array``, ``Group.array``, had the default
17+
``fill_value`` changed from ``0`` to the ``DEFAULT_FILL_VALUE`` value, which instructs Zarr to
18+
use the default scalar value associated with the array's data type as the fill value. These are
19+
all functions or methods for array creation that mirror, wrap or are wrapped by, another function
20+
that already has a default ``fill_value`` set to ``DEFAULT_FILL_VALUE``. This change is necessary
21+
to make these functions consistent across the entire codebase, but as this changes default values,
22+
new data might have a different fill value than expected after this change.
23+
24+
For data types where 0 is meaningful, like integers or floats, the default scalar is 0, so this
25+
change should not be noticeable. For data types where 0 is ambiguous, like fixed-length unicode
26+
strings, the default fill value might be different after this change. Users who were relying on how
27+
Zarr interpreted ``0`` as a non-numeric scalar value should set their desired fill value explicitly
28+
after this change.
1229
- Added public API for Buffer ABCs and implementations.
1330

1431
Use :mod:`zarr.buffer` to access buffer implementations, and

0 commit comments

Comments
 (0)