From 79bb99412f89a417b43e8e4b5c61890941ea46e8 Mon Sep 17 00:00:00 2001 From: themanforfree Date: Sat, 17 Feb 2024 21:02:39 +0800 Subject: [PATCH] chore: add more comments Signed-off-by: themanforfree --- crates/xline/src/storage/revision.rs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/crates/xline/src/storage/revision.rs b/crates/xline/src/storage/revision.rs index 222f6bc39..b5e3bf2b3 100644 --- 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 {