fix(docs): mark rectangular chunk grid as experimental since it is …

…based on a draft ZEP
LDeakin · Jan 17, 2025 · aecaffb · aecaffb
1 parent b493c5e
commit aecaffb
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 - New clippy lints
 - Mark `String` and `Bytes` data types as experimental in their docs
+- Mark `rectangular` chunk grid as experimental since it is based on a draft ZEP
 
 ## [0.19.0] - 2025-01-10
 

diff --git a/zarrs/doc/status/chunk_grids.md b/zarrs/doc/status/chunk_grids.md
@@ -1,7 +1,7 @@
-| Chunk Grid    | ZEP       | V3      | V2      | Feature Flag |
-| ------------- | --------- | ------- | ------- | ------------ |
-| [regular]     | [ZEP0001] | &check; | &check; |              |
-| [rectangular] | [ZEP0003] | &check; |         |              |
+| Chunk Grid                   | ZEP               | V3      | V2      | Feature Flag |
+| ---------------------------- | ----------------- | ------- | ------- | ------------ |
+| [regular]                    | [ZEP0001]         | &check; | &check; |              |
+| [rectangular] (experimental) | [ZEP0003] (draft) | &check; |         |              |
 
 [regular]: crate::array::chunk_grid::RegularChunkGrid
 [rectangular]: crate::array::chunk_grid::RectangularChunkGrid

diff --git a/zarrs/src/array/chunk_grid/rectangular.rs b/zarrs/src/array/chunk_grid/rectangular.rs
@@ -1,5 +1,7 @@
 //! The `rectangular` chunk grid.
 //!
+//! This chunk grid is considered experimental as it is based on a draft Zarr enhancement proposal.
+//!
 //! See <https://zarr.dev/zeps/draft/ZEP0003.html>.
 
 use std::num::NonZeroU64;