add documentation

meilisearch · Apr 29, 2024 · a36a40d · a36a40d
1 parent 0baef3b
commit a36a40d
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/heed/src/reserved_space.rs b/heed/src/reserved_space.rs
@@ -39,6 +39,9 @@ impl ReservedSpace {
 
  /// Fills the remaining reserved space with zeroes.
  ///
+ /// This can be used together with [`written_mut`](Self::written_mut) to get a mutable view of
+ /// the entire reserved space.
+ ///
  /// ### Note
  ///
  /// After calling this function, the entire space is considered to be filled and any