alamb opened a new pull request, #24674: URL: https://github.com/apache/datafusion/pull/24674
## Which issue does this PR close? - N/A (minor doc fix). Follow on to #24637, addressing https://github.com/apache/datafusion/pull/24637#discussion_r3856817631 ## Rationale for this change The docs for [`get_record_batch_memory_size`](https://docs.rs/datafusion/latest/datafusion/common/utils/memory/fn.get_record_batch_memory_size.html) say the function "provides temporary fix until the issue is resolved: <https://github.com/apache/arrow-rs/issues/6439>". As @nuno-faria pointed out in the review of #24637, that issue has since been closed, so the "temporary fix" framing and the issue link are stale. Note that the issue was closed in favor of the memory tracking epic <https://github.com/apache/arrow-rs/issues/8137> rather than by changing [`RecordBatch::get_array_memory_size`], which still double counts `Buffer`s shared between arrays. The double-counting comparison is therefore still accurate and useful for explaining why this function exists, so this PR keeps that sentence and only removes the stale "temporary fix" wording and the closed issue link. ## What changes are included in this PR? - Rewrite the `Note:` paragraph on `get_record_batch_memory_size` to drop the "temporary fix until the issue is resolved" wording and the link to the closed arrow-rs issue, keeping the (still true) statement that `RecordBatch::get_array_memory_size` double counts shared buffers - Use an intra-doc link for `RecordBatch::get_array_memory_size` (this also fixes the stray backtick on that line; #24637 fixes the same line, so whichever PR merges second will need a trivial rebase) ## Are these changes tested? Yes: `RUSTDOCFLAGS="-D warnings" cargo doc -p datafusion-common --no-deps` passes (this also verifies the intra-doc link resolves). ## Are there any user-facing changes? Documentation only. -- 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]
