Skip to content

Commit 144ebf9

Browse files
Minor: Update documentations for memory pool (#14278)
* chore: udpate documentations for memory pool * chore: clippy
1 parent 633eef6 commit 144ebf9

File tree

1 file changed

+6
-3
lines changed
  • datafusion/execution/src/memory_pool

1 file changed

+6
-3
lines changed

datafusion/execution/src/memory_pool/mod.rs

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
// specific language governing permissions and limitations
1616
// under the License.
1717

18-
//! [`MemoryPool`] for memory management during query execution, [`proxy]` for
18+
//! [`MemoryPool`] for memory management during query execution, [`proxy`] for
1919
//! help with allocation accounting.
2020
2121
use datafusion_common::{internal_err, Result};
@@ -108,6 +108,9 @@ pub use pool::*;
108108
///
109109
/// * [`FairSpillPool`]: Limits memory usage to a fixed size, allocating memory
110110
/// to all spilling operators fairly
111+
///
112+
/// * [`TrackConsumersPool`]: Wraps another [`MemoryPool`] and tracks consumers,
113+
/// providing better error messages on the largest memory users.
111114
pub trait MemoryPool: Send + Sync + std::fmt::Debug {
112115
/// Registers a new [`MemoryConsumer`]
113116
///
@@ -140,9 +143,9 @@ pub trait MemoryPool: Send + Sync + std::fmt::Debug {
140143
/// [`MemoryReservation`] in a [`MemoryPool`]. All allocations are registered to
141144
/// a particular `MemoryConsumer`;
142145
///
143-
/// For help with allocation accounting, see the [proxy] module.
146+
/// For help with allocation accounting, see the [`proxy`] module.
144147
///
145-
/// [proxy]: crate::memory_pool::proxy
148+
/// [proxy]: datafusion_common::utils::proxy
146149
#[derive(Debug, PartialEq, Eq, Hash, Clone)]
147150
pub struct MemoryConsumer {
148151
name: String,

0 commit comments

Comments
 (0)