small agg limit docs improvement (#2073)

small docs improvement as follow up on bug quickwit-oss/quickwit#3503
quickwit-oss · Jun 12, 2023 · 3546e7f · 3546e7f
1 parent 862f367
commit 3546e7f
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/aggregation/agg_limits.rs b/src/aggregation/agg_limits.rs
@@ -60,6 +60,8 @@ impl AggregationLimits {
     /// *bucket_limit*
     /// Limits the maximum number of buckets returned from an aggregation request.
     /// bucket_limit will default to `DEFAULT_BUCKET_LIMIT` (65000)
+    ///
+    /// Note: The returned instance contains a Arc shared counter to track memory consumption.
     pub fn new(memory_limit: Option<u64>, bucket_limit: Option<u32>) -> Self {
         Self {
             memory_consumption: Default::default(),