From 1b476b8a35655283840cca3f37ce1af691d3feb5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Cl=C3=A9ment=20Renault?= <clement@meilisearch.com>
Date: Thu, 17 Jul 2025 17:26:41 +0200
Subject: [PATCH] Add documentation to the new documents_file dump reader
 method

Co-authored-by: Louis Dureuil <louis@meilisearch.com>
---
 crates/dump/src/reader/mod.rs | 1 +
 1 file changed, 1 insertion(+)

diff --git a/crates/dump/src/reader/mod.rs b/crates/dump/src/reader/mod.rs
index 91c6d5880..c894c255f 100644
--- a/crates/dump/src/reader/mod.rs
+++ b/crates/dump/src/reader/mod.rs
@@ -192,6 +192,7 @@ impl DumpIndexReader {
         }
     }
 
+    /// A reference to a file in the NDJSON format containing all the documents of the index
     pub fn documents_file(&self) -> &File {
         match self {
             DumpIndexReader::Current(v6) => v6.documents_file(),