Skip to content

Commit

Permalink
chore: update docs to explain purpose of TrackConsumersPool
Browse files Browse the repository at this point in the history
Co-authored-by: Andrew Lamb <[email protected]>
  • Loading branch information
wiedld and alamb committed Jul 30, 2024
1 parent f75764e commit c3ce60f
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions datafusion/execution/src/memory_pool/pool.rs
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,9 @@ fn insufficient_capacity_err(
/// A [`MemoryPool`] that tracks the consumers that have
/// reserved memory within the inner memory pool.
///
/// By tracking memory reservations more carefully this pool
/// can provide better error messages on the largest memory users
///
/// Tracking is per hashed [`MemoryConsumer`], not per [`MemoryReservation`].
/// The same consumer can have multiple reservations.
#[derive(Debug)]
Expand Down

0 comments on commit c3ce60f

Please sign in to comment.