Skip to content

Commit

Permalink
doc: improved documentation for remove_fully
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
RustyNova016 committed Jun 11, 2024
1 parent c102c01 commit d4f5135
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions src/index.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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<P, K>(self, cache: P, key: K) -> Result<()>
where
P: AsRef<Path>,
Expand All @@ -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<P, K>(self, cache: P, key: K) -> Result<()>
where
Expand Down

0 comments on commit d4f5135

Please sign in to comment.