Add new rustdoc lint to detect if merged doctests failed to compile
Open
@GuillaumeGomez is already working on this.
Since Jul 11, 2024.
A-doctests
A-lints
C-feature-request
T-rustdoc
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
This is a follow-up of https://github.com/rust-lang/rust/pull/126245.
This lint would allow to detect the following situation: a user is running doctests in 2024 edition, however the merged doctests failed to be compiled. By default, rustdoc will recompile each of these doctests separately (the current behaviour) but won't notify the users, making them unable to benefit for the improved speed.
This lint would warn if such a case occur and show the compiler output.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.