docs: Fix rendering of get_record_batch_memory_size buffer diagram - #24637
Merged
alamb merged 1 commit intoAug 25, 2026
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #24637 +/- ##
==========================================
- Coverage 81.43% 81.43% -0.01%
==========================================
Files 1118 1118
Lines 399414 399414
Branches 399414 399414
==========================================
- Hits 325278 325260 -18
- Misses 55145 55155 +10
- Partials 18991 18999 +8 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
nuno-faria
approved these changes
Aug 25, 2026
Comment on lines
+147
to
+148
| /// same `Buffer`. This method provides a temporary fix until the issue is | ||
| /// resolved: <https://github.com/apache/arrow-rs/issues/6439> |
Contributor
There was a problem hiding this comment.
I wonder if this is still needed, since the issue has been completed.
Contributor
Author
There was a problem hiding this comment.
That is an excellent point -- I will remove it in a follow on PR
Contributor
Author
There was a problem hiding this comment.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Which issue does this PR close?
Rationale for this change
The docs for
get_record_batch_memory_sizerender poorly on docs.rs:Current `RecordBatch`.get_array_memory_size()` will ...causes the rest of the paragraph to render as inline codeThe diagram currently renders as this single line:
What changes are included in this PR?
textcode fence so it renders as drawnRecordBatch::get_array_memory_sizeAre these changes tested?
Yes:
RUSTDOCFLAGS="-D warnings" cargo doc -p datafusion-common --no-depspasses (this also verifies the new intra-doc link resolves).Are there any user-facing changes?
Documentation only.