alamb opened a new pull request, #24637: URL: https://github.com/apache/datafusion/pull/24637
## 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 <img width="600" alt="Screenshot of broken rendering" src="https://docs.rs/datafusion/latest/datafusion/common/utils/memory/fn.get_record_batch_memory_size.html"; /> ## 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. -- 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]
