Merge pull request #296 from t20100/sz3-warning

Added a warning about `SZ3` filter compatibility
silx-kit · Feb 8, 2024 · 2aaeb14 · 2aaeb14
2 parents cf873a4 + 6e270c2
commit 2aaeb14
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/hdf5plugin/_filters.py b/src/hdf5plugin/_filters.py
@@ -587,6 +587,11 @@ class SZ3(_FilterRefClass):
               **hdf5plugin.SZ3(absolute=0.1))
 
     For more details about the compressor, see `SZ3 <https://szcompressor.org/>`_.
+
+    .. warning::
+
+       Backward compatibility is currently not guaranteed:
+       See `this discussion <https://github.com/szcompressor/SZ3/issues/50#issuecomment-1901170917>`_.
     """
     filter_name = "sz3"
     filter_id = SZ3_ID