From f88eab184cd3e17e420254f0cdb7d8c0fa83bb83 Mon Sep 17 00:00:00 2001
From: Robin Mueller <robin.mueller.m@gmail.com>
Date: Sat, 19 Nov 2022 12:45:41 +0100
Subject: [PATCH] more docs

---
 fsrc-core/src/pool.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/fsrc-core/src/pool.rs b/fsrc-core/src/pool.rs
index 8411a35..8b7c841 100644
--- a/fsrc-core/src/pool.rs
+++ b/fsrc-core/src/pool.rs
@@ -405,6 +405,8 @@ impl<'a> PoolGuard<'a> {
         self.pool.read(&self.addr)
     }
 
+    /// Releasing the pool guard will disable the automatic deletion of the data when the guard
+    /// is dropped.
     pub fn release(&mut self) {
         self.no_deletion = true;
     }
@@ -438,6 +440,8 @@ impl<'a> PoolRwGuard<'a> {
     delegate!(
         to self.guard {
             pub fn read(&self) -> Result<&[u8], StoreError>;
+            /// Releasing the pool guard will disable the automatic deletion of the data when the guard
+            /// is dropped.
             pub fn release(&mut self);
         }
     );