compile_fail
and should_panic
examples are tested wherever possible
#2957
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A couple of days ago there was a question on URLO, which uncovered the fact that some compile-fail cases in the Book are not marked as such. After some research, I've decided to propose the following:
rustdoc
annotations (compile_fail
andshould_panic
) instead of customdoes_not_compile
andpanics
.ignore
annotation wherever possible, so that the examples, including non-compiling or panicking ones, are checked to behave as expected.should_panic
orcompile_fail
annotations wherever they seem to be expected.Note that some failing examples can't be tested, because the failing code is
#[cfg(test)]
, and this property is not set for doctests. These examples are, however, explicitly marked as bothcompile_fail
orshould_panic
andignore
, so that it would be now easy to grep for them during future changes.