From fd0662b66d7a487c1c890c13774188b9bf6a32b6 Mon Sep 17 00:00:00 2001 From: mehbark Date: Fri, 3 Oct 2025 16:10:30 -0400 Subject: [PATCH] improve phrasing of `CompressionScheme` docs --- src/compression_scheme.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/compression_scheme.rs b/src/compression_scheme.rs index c953381..9fc5c25 100644 --- a/src/compression_scheme.rs +++ b/src/compression_scheme.rs @@ -10,14 +10,14 @@ pub trait CompressionScheme { /// Encode some bytes into `buf`, returning a [`Header`][Self::Header]. /// /// This does not necessarily have to be deterministic, - /// but it **must** always be decodable by [`decode`](Self::decode). + /// but it **must** be decodable by [`decode`](Self::decode). /// That is, [`decode`](Self::decode) ∘ [`encode`](Self::encode) = `id`. fn encode(src: &[u8], buf: &mut BitVec) -> Self::Header; /// Decode the given bits and header into `buf`. /// /// This may panic on arbitrary input, - /// but it **must** always decode outputs of [`encode`](Self::encode). + /// but it **must** successfully decode outputs of [`encode`](Self::encode). /// That is, [`decode`](Self::decode) ∘ [`encode`](Self::encode) = `id`. fn decode(src: &BitSlice, header: &Self::Header, buf: &mut Vec);