asolimando opened a new pull request, #25718: URL: https://github.com/apache/datafusion/pull/25718
## Which issue does this PR close? None. This is a small, standalone documentation addition. ## Rationale for this change The "API Documentation Examples" section of the testing guide explains that doctests are checked by `cargo test --doc`, but says nothing about keeping them readable. @alamb pointed out on PR #25689 that prefixing a line with `#` keeps it compiled while hiding it from the rendered docs, most useful for `use` statements. ## What changes are included in this PR? Add a short note and example to `docs/source/contributor-guide/testing.md` documenting this. ## Are these changes tested? N/A, documentation only. ## Are there any user-facing changes? No, contributor documentation only. ---- Disclaimer: I used AI to assist in the code generation, I have manually reviewed the output and it matches my intention and understanding. -- 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]
