update create_in_ram docs (#1695)

quickwit-oss · Nov 24, 2022 · 0281b22 · 0281b22
1 parent 0b40a7f
commit 0281b22
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/core/index.rs b/src/core/index.rs
@@ -149,7 +149,8 @@ impl IndexBuilder {
     /// Creates a new index using the [`RamDirectory`].
     ///
     /// The index will be allocated in anonymous memory.
-    /// This should only be used for unit tests.
+    /// This is useful for indexing small set of documents
+    /// for instances like unit test or temporary in memory index.
     pub fn create_in_ram(self) -> Result<Index, TantivyError> {
         let ram_directory = RamDirectory::create();
         self.create(ram_directory)