alamb commented on code in PR #9025:
URL: https://github.com/apache/arrow-datafusion/pull/9025#discussion_r1468842663
##########
datafusion/execution/src/memory_pool/mod.rs:
##########
@@ -107,9 +108,13 @@ pub trait MemoryPool: Send + Sync + std::fmt::Debug {
fn reserved(&self) -> usize;
}
-/// A memory consumer that can be tracked by [`MemoryReservation`] in
-/// a [`MemoryPool`]. All allocations are registered to a particular
-/// `MemoryConsumer`;
+/// A memory consumer is a named allocation traced by a particular
+/// [`MemoryReservation`] in a [`MemoryPool`]. All allocations are registered
to
+/// a particular `MemoryConsumer`;
+///
+/// For help with allocation accounting, see the [proxy] module.
+///
+/// [proxy]: crate::memory_pool::proxy
Review Comment:
Yeah, I also find `proxy` non intuitive -- the extension traits aren't
really proxies for anything. Maybe we should move them to
`crate::memory_pool::extensions` or `crate::memory_pool::utils` 🤔
I suppose at least this PR documents them which is an improvement
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
