From 4e1017990f8a4cf7611cc94f5667fa2bec05023b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Cl=C3=A9ment=20Renault?= <clement@meilisearch.com>
Date: Mon, 25 Nov 2024 10:44:04 +0100
Subject: [PATCH] Add more documentation to the ArrayStore capacity method

---
 roaring/src/bitmap/store/array_store/mod.rs | 1 +
 1 file changed, 1 insertion(+)

diff --git a/roaring/src/bitmap/store/array_store/mod.rs b/roaring/src/bitmap/store/array_store/mod.rs
index e1b2b9af..b13f04cc 100644
--- a/roaring/src/bitmap/store/array_store/mod.rs
+++ b/roaring/src/bitmap/store/array_store/mod.rs
@@ -30,6 +30,7 @@ impl ArrayStore {
         ArrayStore { vec: Vec::with_capacity(capacity) }
     }
 
+    /// The number of total values that can be inserted without needing to reallocate.
     pub fn capacity(&self) -> usize {
         self.vec.capacity()
     }