Repository navigation
Commit 6e66a85
authored
docs: Fix rendering of
## Which issue does this PR close?
- N/A (minor doc fix). Follow on to #24592, which I noticed while
reviewing that PR.
## 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)
render poorly on docs.rs:
1. The ASCII-art buffer diagram is not in a code block, so rustdoc
collapses it into a single unreadable line
2. A stray backtick in ```Current `RecordBatch`.get_array_memory_size()`
will ...``` causes the rest of the paragraph to render as inline code
The diagram currently renders as this single line:
```
{xxxxxxxxxxxxxxxxxxx} <— buffer ^ ^ ^ ^ | | | | col1->{ } | | col2———>{ }
```
<img width="1541" height="871" alt="Screenshot 2026-08-24 at 3 29 49 PM"
src="https://github.com/user-attachments/assets/efd24f7e-f6d9-4ac6-aaee-9c2849851c2d"
/>
## What changes are included in this PR?
- Wrap the diagram in a `text` code fence so it renders as drawn
- Replace the mis-quoted method reference with an intra-doc link to
`RecordBatch::get_array_memory_size`
## Are these changes tested?
Yes: `RUSTDOCFLAGS="-D warnings" cargo doc -p datafusion-common
--no-deps` passes (this also verifies the new intra-doc link resolves).
## Are there any user-facing changes?
Documentation only.get_record_batch_memory_size buffer diagram (#24637)1 parent 1064661 commit 6e66a85
1 file changed
Lines changed: 6 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
131 | 131 | | |
132 | 132 | | |
133 | 133 | | |
| 134 | + | |
134 | 135 | | |
135 | 136 | | |
136 | 137 | | |
137 | 138 | | |
138 | 139 | | |
| 140 | + | |
139 | 141 | | |
140 | 142 | | |
141 | 143 | | |
142 | 144 | | |
143 | | - | |
144 | | - | |
145 | | - | |
146 | | - | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
147 | 149 | | |
148 | 150 | | |
149 | 151 | | |
| |||
0 commit comments