alamb commented on code in PR #24637:
URL: https://github.com/apache/datafusion/pull/24637#discussion_r3856817631
##########
datafusion/common/src/utils/memory.rs:
##########
@@ -131,19 +131,21 @@ pub fn estimate_memory_size<T>(num_elements: usize,
fixed_size: usize) -> Result
/// For a `RecordBatch` with two columns: `col1` and `col2`, two columns are
pointing
/// to a sub-region of the same buffer.
///
+/// ```text
/// {xxxxxxxxxxxxxxxxxxx} <--- buffer
/// ^ ^ ^ ^
/// | | | |
/// col1->{ } | |
/// col2--------->{ }
+/// ```
///
/// In the above case, `get_record_batch_memory_size` will return the size of
/// the buffer, instead of the sum of `col1` and `col2`'s actual memory size.
///
-/// Note: Current `RecordBatch`.get_array_memory_size()` will double count the
-/// buffer memory size if multiple arrays within the batch are sharing the same
-/// `Buffer`. This method provides temporary fix until the issue is resolved:
-/// <https://github.com/apache/arrow-rs/issues/6439>
+/// Note: The current [`RecordBatch::get_array_memory_size`] will double count
+/// the buffer memory size if multiple arrays within the batch are sharing the
+/// same `Buffer`. This method provides a temporary fix until the issue is
+/// resolved: <https://github.com/apache/arrow-rs/issues/6439>
Review Comment:
That is an excellent point -- I will remove it in a follow on PR
--
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]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
