From 3a712473645d05b256b430102ae809190e5d4f60 Mon Sep 17 00:00:00 2001 From: RustyNova <50844553+RustyNova016@users.noreply.github.com> Date: Tue, 11 Jun 2024 08:05:11 +0000 Subject: [PATCH] fix(docs): improved documentation for remove_fully (#78) The documentation is outdated since #63. This merge request aims to update it to reflect the new changes. According to the the release notes for v13.0.0, this is meant to be a fix, but the documentation makes it looks like a bug. --- src/index.rs | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/src/index.rs b/src/index.rs index b9f5257..9ecb961 100644 --- a/src/index.rs +++ b/src/index.rs @@ -393,13 +393,15 @@ impl RemoveOpts { } /// Set the remove fully option - /// If remove_fully is set to true then the index file itself will be physically deleted rather than appending a null. + /// If remove_fully is set to true then the index and content file itself will be physically deleted rather than appending a null. pub fn remove_fully(mut self, remove_fully: bool) -> Self { self.remove_fully = remove_fully; self } - /// Removes an individual index metadata entry. The associated content will be left in the cache. + /// Removes an individual index metadata entry. + /// If remove_fully is set to false (default), the associated content will be left in the cache. + /// If remove_fully is true, both the index entry and the contents will be physically removed from the disk pub fn remove_sync(self, cache: P, key: K) -> Result<()> where P: AsRef, @@ -419,7 +421,9 @@ impl RemoveOpts { } } - /// Removes an individual index metadata entry. The associated content will be left in the cache. + /// Removes an individual index metadata entry. + /// If remove_fully is set to false (default), the associated content will be left in the cache. + /// If remove_fully is true, both the index entry and the contents will be physically removed from the disk #[cfg(any(feature = "async-std", feature = "tokio"))] pub async fn remove(self, cache: P, key: K) -> Result<()> where