Update root docs for new vlen related codecs/data types

LDeakin · Jul 25, 2024 · 5bc59ea · 5bc59ea
1 parent ab080a1
commit 5bc59ea
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 20 deletions.
diff --git a/doc/status/codecs.md b/doc/status/codecs.md
@@ -1,16 +1,18 @@
-| Codec Type     | Codec<sup>†</sup>         | ZEP               | V3      | V2      | Feature Flag* |
-| -------------- | ------------------------- | ----------------- | ------- | ------- | ------------- |
-| Array to Array | [transpose]               | [ZEP0001]         | &check; |         | **transpose** |
-|                | [bitround] (experimental) |                   | &check; |         | bitround      |
-| Array to Bytes | [bytes]                   | [ZEP0001]         | &check; |         |               |
-|                | [sharding_indexed]        | [ZEP0002]         | &check; |         | **sharding**  |
-|                | [zfp] (experimental)      |                   | &check; |         | zfp           |
-|                | [pcodec] (experimental)   |                   | &check; |         | pcodec        |
-| Bytes to Bytes | [blosc]                   | [ZEP0001]         | &check; | &check; | **blosc**     |
-|                | [gzip]                    | [ZEP0001]         | &check; | &check; | **gzip**      |
-|                | [crc32c]                  | [ZEP0002]         | &check; |         | **crc32c**    |
-|                | [zstd]                    | [zarr-specs #256] | &check; |         | zstd          |
-|                | [bz2] (experimental)      |                   | &check; | &check; | bz2           |
+| Codec Type     | Codec<sup>†</sup>                      | ZEP               | V3      | V2      | Feature Flag* |
+| -------------- | ---------------------------------      | ----------------- | ------- | ------- | ------------- |
+| Array to Array | [transpose]                            | [ZEP0001]         | &check; |         | **transpose** |
+|                | [bitround] (experimental)              |                   | &check; |         | bitround      |
+| Array to Bytes | [bytes]                                | [ZEP0001]         | &check; |         |               |
+|                | [sharding_indexed]                     | [ZEP0002]         | &check; |         | **sharding**  |
+|                | [zfp] (experimental)                   |                   | &check; |         | zfp           |
+|                | [pcodec] (experimental)                |                   | &check; |         | pcodec        |
+|                | [vlen] (experimental)                  |                   | &check; |         |               |
+| | V3 [vlen_interleaved] (experimental)<br>V2 vlen-utf8/vlen-bytes/vlen-array | | &check; | &check; | |
+| Bytes to Bytes | [blosc]                                | [ZEP0001]         | &check; | &check; | **blosc**     |
+|                | [gzip]                                 | [ZEP0001]         | &check; | &check; | **gzip**      |
+|                | [crc32c]                               | [ZEP0002]         | &check; |         | **crc32c**    |
+|                | [zstd]                                 | [zarr-specs #256] | &check; |         | zstd          |
+|                | [bz2] (experimental)                   |                   | &check; | &check; | bz2           |
 
 <sup>\* Bolded feature flags are part of the default set of features.</sup>
 <br>
@@ -31,12 +33,16 @@
 [crc32c]: crate::array::codec::bytes_to_bytes::crc32c
 [zstd]: crate::array::codec::bytes_to_bytes::zstd
 [bz2]: crate::array::codec::bytes_to_bytes::bz2
+[vlen]: crate::array::codec::array_to_bytes::vlen
+[vlen_interleaved]: crate::array::codec::array_to_bytes::vlen_interleaved
 
 The `"name"` of of experimental codecs in array metadata links the codec documentation in this crate.
 
-| Experimental Codec | Name / URI                                        |
-| ------------------ | ------------------------------------------------- |
-| `bitround`         | <https://codec.zarrs.dev/array_to_array/bitround> |
-| `zfp`              | <https://codec.zarrs.dev/array_to_bytes/zfp>      |
-| `pcodec`           | <https://codec.zarrs.dev/array_to_bytes/pcodec>   |
-| `bz2`              | <https://codec.zarrs.dev/bytes_to_bytes/bz2>      |
+| Experimental Codec | Name / URI                                               |
+| ------------------ | -------------------------------------------------------- |
+| `bitround`         | <https://codec.zarrs.dev/array_to_array/bitround>        |
+| `zfp`              | <https://codec.zarrs.dev/array_to_bytes/zfp>             |
+| `pcodec`           | <https://codec.zarrs.dev/array_to_bytes/pcodec>          |
+| `bz2`              | <https://codec.zarrs.dev/bytes_to_bytes/bz2>             |
+| `vlen`             | <https://codec.zarrs.dev/array_to_array/vlen>            |
+| `vlen_interleaved` | <https://codec.zarrs.dev/array_to_array/zfp_interleaved> |
diff --git a/doc/status/data_types.md b/doc/status/data_types.md
@@ -1,8 +1,12 @@
-| Data Type | ZEP | V3 | V2 | Feature Flag |
+| Data Type<sup>†</sup> | ZEP | V3 | V2 | Feature Flag |
 | --------- | --- | ----- | -- | ------------ |
 | [bool]<br>[int8] [int16] [int32] [int64] [uint8] [uint16] [uint32] [uint64]<br>[float16] [float32] [float64]<br>[complex64] [complex128] | [ZEP0001] | &check; | &check; | |
 [r* (raw bits)] | [ZEP0001] | &check; | | |
 | [bfloat16] | [zarr-specs #130] | &check; | | |
+| [string] (experimental) | [ZEP0007 (draft)] | &check; | | |
+| [binary] (experimental) | [ZEP0007 (draft)] | &check; | | |
+
+<sup>† Experimental data types are recommended for evaluation only.</sup>
 
 [bool]: crate::array::data_type::DataType::Bool
 [int8]: crate::array::data_type::DataType::Int8
@@ -20,6 +24,9 @@
 [complex128]: crate::array::data_type::DataType::Complex128
 [bfloat16]: crate::array::data_type::DataType::BFloat16
 [r* (raw bits)]: crate::array::data_type::DataType::RawBits
+[string]: crate::array::data_type::DataType::String
+[binary]: crate::array::data_type::DataType::Binary
 
 [ZEP0001]: https://zarr.dev/zeps/accepted/ZEP0001.html
 [zarr-specs #130]: https://github.com/zarr-developers/zarr-specs/issues/130
+[ZEP0007 (draft)]: https://github.com/zarr-developers/zeps/pull/47