chore: add a comment to the recover behavior of the curp db

Signed-off-by: bsbds <69835502+bsbds@users.noreply.github.com>
xline-kv · Jul 29, 2024 · fe71e78 · fe71e78
1 parent 3157abf
commit fe71e78
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/crates/curp/src/server/storage/db.rs b/crates/curp/src/server/storage/db.rs
@@ -159,6 +159,9 @@ impl<C: Command> StorageApi for DB<C> {
 
 impl<C> DB<C> {
     /// Create a new CURP `DB`
+    ///
+    /// WARN: The `recover` method must be called before any call to `put_log_entries`.
+    ///
     /// # Errors
     /// Will return `StorageError` if failed to open the storage
     #[inline]