From 4ae7a19c2bb2996dc4739dfd3ebbe32b17ac1658 Mon Sep 17 00:00:00 2001 From: Tom Nicholas Date: Thu, 7 Nov 2024 10:12:13 -0700 Subject: [PATCH] Fix release notes for v1.1.0 (#288) * add new section to release notes for unreleased additions * add release note for #191 * add release note for #266 * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * pre-commit --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- docs/releases.rst | 49 +++++++++++++++++++++++++++++++++-------------- 1 file changed, 35 insertions(+), 14 deletions(-) diff --git a/docs/releases.rst b/docs/releases.rst index 1e2bdb90..cadbc855 100644 --- a/docs/releases.rst +++ b/docs/releases.rst @@ -1,36 +1,62 @@ Release notes ============= -.. _v1.0.1: +.. _v1.1.1: -v1.0.1 (unreleased) +v1.1.1 (unreleased) ------------------- New Features ~~~~~~~~~~~~ +Breaking changes +~~~~~~~~~~~~~~~~ + +- Minimum required version of Xarray is now v2024.10.0. + (:pull:`284`) By `Tom Nicholas `_. + +Deprecations +~~~~~~~~~~~~ + +Bug fixes +~~~~~~~~~ + +- Fixed bug with writing of `dimension_names` into zarr metadata. + (:pull:`286`) By `Tom Nicholas `_. +- Fixed bug causing CF-compliant variables not to be identified as coordinates (:pull:`191`) + By `Ayush Nag `_. + +Documentation +~~~~~~~~~~~~~ + +- FAQ answers on Icechunk compatibility, converting from existing Kerchunk references to Icechunk, and how to add a new reader for a custom file format. + (:pull:`266`) By `Tom Nicholas `_. + +Internal Changes +~~~~~~~~~~~~~~~~ + +.. _v1.1.0: + +v1.1.0 (22nd Oct 2024) +---------------------- + +New Features +~~~~~~~~~~~~ - Can open `kerchunk` reference files with ``open_virtual_dataset``. (:pull:`251`, :pull:`186`) By `Raphael Hagen `_ & `Kristen Thyng `_. - - Adds defaults for `open_virtual_dataset_from_v3_store` in (:pull:`234`) By `Raphael Hagen `_. - - New ``group`` option on ``open_virtual_dataset`` enables extracting specific HDF Groups. (:pull:`165`) By `Scott Henderson `_. - - Adds `decode_times` to open_virtual_dataset (:pull:`232`) By `Raphael Hagen `_. - - Add parser for the OPeNDAP DMR++ XML format and integration with open_virtual_dataset (:pull:`113`) By `Ayush Nag `_. - - Load scalar variables by default. (:pull:`205`) By `Gustavo Hidalgo `_. - - Support empty files (:pull:`260`) By `Justus Magin `_. - - Can write virtual datasets to Icechunk stores using `vitualize.to_icechunk` (:pull:`256`) By `Matt Iannucci `_. @@ -42,8 +68,6 @@ Breaking changes - VirtualiZarr's `ZArray`, `ChunkEntry`, and `Codec` no longer subclass `pydantic.BaseModel` (:pull:`210`) - `ZArray`'s `__init__` signature has changed to match `zarr.Array`'s (:pull:`210`) -- Minimum required version of Xarray is now v2024.10.0. - (:pull:`284`) By `Tom Nicholas `_. Deprecations ~~~~~~~~~~~~ @@ -59,8 +83,6 @@ Bug fixes - Fixed regression in `fill_value` handling for datetime dtypes making virtual Zarr stores unreadable (:pull:`206`) By `Timothy Hodson `_ -- Fixed bug with writing of `dimension_names` into zarr metadata. - (:pull:`286`) By `Tom Nicholas `_. Documentation ~~~~~~~~~~~~~ @@ -68,7 +90,6 @@ Documentation - Adds virtualizarr + coiled serverless example notebook (:pull:`223`) By `Raphael Hagen `_. - Internal Changes ~~~~~~~~~~~~~~~~