chore: add more comments

Signed-off-by: themanforfree <[email protected]>
xline-kv · Feb 18, 2024 · 79bb994 · 79bb994
1 parent 775056f
commit 79bb994
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/crates/xline/src/storage/revision.rs b/crates/xline/src/storage/revision.rs
@@ -68,6 +68,8 @@ impl Revision {
     }
 
     /// Decode `Revision` from `&[u8]`
+    /// # Panics
+    /// This function panics if there is not enough remaining data in `buf`.
     #[must_use]
     #[inline]
     pub fn decode(mut buf: &[u8]) -> Self {