update create_in_ram docs (#1695)

This commit is contained in:
PSeitz
2022-11-24 17:30:09 +01:00
committed by GitHub
parent 0b40a7fe43
commit 0281b22b77

View File

@@ -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)