fix(docs): clarify that zstd is draft and gdeflate are experimental i…

…n their docs
LDeakin · Dec 9, 2024 · 208f3d5 · 208f3d5
1 parent 638b166
commit 208f3d5
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 - Fix `unsafe_op_in_unsafe_fn` in lint
+- Clarify that zstd is draft and gdeflate are experimental in their docs
 
 ## [0.18.0] - 2024-11-23
 

diff --git a/zarrs/src/array/codec/array_to_array/bitround.rs b/zarrs/src/array/codec/array_to_array/bitround.rs
@@ -4,7 +4,7 @@
 //! Rounds integers to the specified number of bits from the most significant set bit.
 //!
 //! <div class="warning">
-//! This codec is experimental and is incompatible with other Zarr V3 implementations.
+//! This codec is experimental and may be incompatible with other Zarr V3 implementations.
 //! </div>
 //!
 //! This codec requires the `bitround` feature, which is disabled by default.

diff --git a/zarrs/src/array/codec/array_to_bytes/pcodec.rs b/zarrs/src/array/codec/array_to_bytes/pcodec.rs
@@ -3,7 +3,7 @@
 //! [Pcodec](https://github.com/mwlon/pcodec) (or Pco, pronounced "pico") losslessly compresses and decompresses numerical sequences with high compression ratio and fast speed.
 //!
 //! <div class="warning">
-//! This codec is experimental and is incompatible with other Zarr V3 implementations.
+//! This codec is experimental and may be incompatible with other Zarr V3 implementations.
 //! </div>
 //!
 //! This codec requires the `pcodec` feature, which is disabled by default.

diff --git a/zarrs/src/array/codec/array_to_bytes/zfp.rs b/zarrs/src/array/codec/array_to_bytes/zfp.rs
@@ -4,7 +4,7 @@
 //! 8/16-bit integer types are supported through promotion to 32-bit in accordance with the [zfp utility functions](https://zfp.readthedocs.io/en/release1.0.1/low-level-api.html#utility-functions).
 //!
 //! <div class="warning">
-//! This codec is experimental and is incompatible with other Zarr V3 implementations.
+//! This codec is experimental and may be incompatible with other Zarr V3 implementations.
 //! </div>
 //!
 //! This codec requires the `zfp` feature, which is disabled by default.

diff --git a/zarrs/src/array/codec/bytes_to_bytes/bz2.rs b/zarrs/src/array/codec/bytes_to_bytes/bz2.rs
@@ -1,7 +1,7 @@
 //! The `bz2` (bzip2) bytes to bytes codec.
 //!
 //! <div class="warning">
-//! This codec is experimental and is incompatible with other Zarr V3 implementations.
+//! This codec is experimental and may be incompatible with other Zarr V3 implementations.
 //! </div>
 //!
 //! This codec requires the `bz2` feature, which is disabled by default.

diff --git a/zarrs/src/array/codec/bytes_to_bytes/gdeflate.rs b/zarrs/src/array/codec/bytes_to_bytes/gdeflate.rs
@@ -2,6 +2,10 @@
 //!
 //! Applies [gdeflate](https://docs.nvidia.com/cuda/nvcomp/gdeflate.html) compression.
 //!
+//! <div class="warning">
+//! This codec is experimental and may be incompatible with other Zarr V3 implementations.
+//! </div>
+//!
 //! `gdeflate` encoded data sequentially encodes a static header, a dynamic header, and the compressed bytes.
 //!
 //! The static header is composed of the following:

diff --git a/zarrs/src/array/codec/bytes_to_bytes/zstd.rs b/zarrs/src/array/codec/bytes_to_bytes/zstd.rs
@@ -2,7 +2,11 @@
 //!
 //! Applies [Zstd](https://tools.ietf.org/html/rfc8878) compression.
 //!
-//! See <https://zarr-specs.readthedocs.io/en/latest/v3/codecs/zstd/v1.0.html>.
+//! <div class="warning">
+//! This codec is based on a draft specification and may be incompatible with other Zarr V3 implementations.
+//! </div>
+//!
+//! See <https://github.com/zarr-developers/zarr-specs/pull/256>.
 
 mod zstd_codec;
 mod zstd_partial_decoder;