From 5daaf7cd5f64d4308eb09d5b69ad22ae9dbb26cf Mon Sep 17 00:00:00 2001
From: Louis Dureuil <louis@meilisearch.com>
Date: Thu, 9 Feb 2023 12:15:53 +0100
Subject: [PATCH] Fix doc comment
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Clément Renault <clement@meilisearch.com>
---
 index-scheduler/src/index_mapper.rs | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/index-scheduler/src/index_mapper.rs b/index-scheduler/src/index_mapper.rs
index 566f515e0..42424490f 100644
--- a/index-scheduler/src/index_mapper.rs
+++ b/index-scheduler/src/index_mapper.rs
@@ -290,6 +290,8 @@ mod index_map {
 
         /// Attempts to delete and index.
         ///
+        ///  `end_deletion` must be called just after.
+        ///
         /// # Status table
         ///
         /// | Previous Status | New Status | Return value |
@@ -312,7 +314,9 @@ mod index_map {
             }
         }
 
-        /// Marks that an index finished deletion.
+        /// Marks that an index deletion finished.
+        ///
+        /// Must be used after calling `start_deletion`.
         ///
         /// # Status table
         ///