Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rustdoc's should_fail isn't very useful #11698

Closed
alexcrichton opened this issue Jan 21, 2014 · 0 comments · Fixed by #12298
Closed

Rustdoc's should_fail isn't very useful #11698

alexcrichton opened this issue Jan 21, 2014 · 0 comments · Fixed by #12298
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@alexcrichton
Copy link
Member

Right now a should_fail doc test will succeed if either compilation fails or the test itself fails. The purpose of testing documentation is to fight bitrot, and if we're succeeding on bitrot, that's not too useful.

Rustdoc should always fail if compilation fails, and it should then fail or succeed depending on the result of the test itself and the presence of the should_fail attribute.
@alexcrichton alexcrichton mentioned this issue Feb 15, 2014
Merged
@bors bors closed this as completed in 0c62d9d Feb 16, 2014
flip1995 pushed a commit to flip1995/rust that referenced this issue Nov 2, 2023
@bors
Auto merge of rust-lang#11698 - a1phyr:waker_clone_and_wake, r=y21
2f0f4dd 
Add `waker_clone_and_wake` lint to check needless `Waker` clones

Check for patterns of `waker.clone().wake()` and replace them with `waker.wake_by_ref()`.

An alternative name could be `waker_clone_then_wake`

changelog: [ `waker_clone_wake`]: new lint
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Change rustdoc to test code blocks by default alexcrichton/rust
1 participant
@alexcrichton