Skip to content

Commit

Permalink
Minor: Update documentations for memory pool (#14278)
Browse files Browse the repository at this point in the history
* chore: udpate documentations for memory pool

* chore: clippy
  • Loading branch information
appletreeisyellow authored Jan 25, 2025
1 parent 633eef6 commit 144ebf9
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions datafusion/execution/src/memory_pool/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
// specific language governing permissions and limitations
// under the License.

//! [`MemoryPool`] for memory management during query execution, [`proxy]` for
//! [`MemoryPool`] for memory management during query execution, [`proxy`] for
//! help with allocation accounting.
use datafusion_common::{internal_err, Result};
Expand Down Expand Up @@ -108,6 +108,9 @@ pub use pool::*;
///
/// * [`FairSpillPool`]: Limits memory usage to a fixed size, allocating memory
/// to all spilling operators fairly
///
/// * [`TrackConsumersPool`]: Wraps another [`MemoryPool`] and tracks consumers,
/// providing better error messages on the largest memory users.
pub trait MemoryPool: Send + Sync + std::fmt::Debug {
/// Registers a new [`MemoryConsumer`]
///
Expand Down Expand Up @@ -140,9 +143,9 @@ pub trait MemoryPool: Send + Sync + std::fmt::Debug {
/// [`MemoryReservation`] in a [`MemoryPool`]. All allocations are registered to
/// a particular `MemoryConsumer`;
///
/// For help with allocation accounting, see the [proxy] module.
/// For help with allocation accounting, see the [`proxy`] module.
///
/// [proxy]: crate::memory_pool::proxy
/// [proxy]: datafusion_common::utils::proxy
#[derive(Debug, PartialEq, Eq, Hash, Clone)]
pub struct MemoryConsumer {
name: String,
Expand Down

0 comments on commit 144ebf9

Please sign in to comment.