From a8bb8f3b2eb8b5a74e1bdcc1958fd20eb514b989 Mon Sep 17 00:00:00 2001
From: Ahmed Yasin Koculu <koculu@gmail.com>
Date: Mon, 22 Aug 2022 10:53:29 +0200
Subject: [PATCH] Update API docs.

---
 src/ZoneTree/IZoneTree.cs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/ZoneTree/IZoneTree.cs b/src/ZoneTree/IZoneTree.cs
index 9fe93c3..06edc4c 100644
--- a/src/ZoneTree/IZoneTree.cs
+++ b/src/ZoneTree/IZoneTree.cs
@@ -134,6 +134,11 @@ public interface IZoneTree<TKey, TValue> : IDisposable
     /// <summary>
     /// Counts Keys in the entire database with a full scan.
     /// </summary>
+    /// <remarks>
+    /// In regular cases, the disk segment does not contain deleted records.
+    /// However, TTL or custom deletion logic would let the disk segment
+    /// contains deleted records. In that case, a full scan is required for the count.
+    /// </remarks>
     /// <returns>Number of the valid records in the tree.</returns>
     int CountFullScan();