You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@datafusion.apache.org by "asolimando (via GitHub)" <gi...@apache.org> on 2026/09/24 20:45:46 UTC
[PR] docs: note the rustdoc trick for hiding use statements in examples [datafusion]
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: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] docs: note the rustdoc trick for hiding use statements in examples [datafusion]
Posted by "codecov-commenter (via GitHub)" <gi...@apache.org>.
codecov-commenter commented on PR #25718:
URL: https://github.com/apache/datafusion/pull/25718#issuecomment-5822337869
## [Codecov](https://app.codecov.io/gh/apache/datafusion/pull/25718?dropdown=coverage&src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) Report
:white_check_mark: All modified and coverable lines are covered by tests.
:white_check_mark: Project coverage is 82.49%. Comparing base ([`b2a2c64`](https://app.codecov.io/gh/apache/datafusion/commit/b2a2c64a52ef3172c53b437d0585b58abeed49c1?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)) to head ([`5939587`](https://app.codecov.io/gh/apache/datafusion/commit/593958730b04baea325a4e815e53c33652c259be?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)).
:warning: Report is 2 commits behind head on main.
<details><summary>Additional details and impacted files</summary>
```diff
@@ Coverage Diff @@
## main #25718 +/- ##
==========================================
- Coverage 82.49% 82.49% -0.01%
==========================================
Files 1140 1140
Lines 438767 438767
Branches 438767 438767
==========================================
- Hits 361978 361965 -13
- Misses 54929 54938 +9
- Partials 21860 21864 +4
```
</details>
[:umbrella: View full report in Codecov by Harness](https://app.codecov.io/gh/apache/datafusion/pull/25718?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
:loudspeaker: Have feedback on the report? [Share it here](https://about.codecov.io/codecov-pr-comment-feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
<details><summary> :rocket: New features to boost your workflow: </summary>
- :snowflake: [Test Analytics](https://docs.codecov.com/docs/test-analytics): Detect flaky tests, report on failures, and find test suite problems.
- :package: [JS Bundle Analysis](https://docs.codecov.com/docs/javascript-bundle-analysis): Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
</details>
--
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: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] docs: note the rustdoc trick for hiding use statements in examples [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb merged PR #25718:
URL: https://github.com/apache/datafusion/pull/25718
--
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: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org