From 0281b22b77606e07d2b1425de430c2301e39bbf9 Mon Sep 17 00:00:00 2001
From: PSeitz <PSeitz@users.noreply.github.com>
Date: Thu, 24 Nov 2022 17:30:09 +0100
Subject: [PATCH] update create_in_ram docs (#1695)

---
 src/core/index.rs | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/core/index.rs b/src/core/index.rs
index 21f79137d..7d942313d 100644
--- 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)