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.

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

compile_fail and should_panic examples are tested wherever possible #2957

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Cerber-Ursi
Copy link

@Cerber-Ursi Cerber-Ursi commented Dec 12, 2021

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:

  • Use rustdoc annotations (compile_fail and should_panic) instead of custom does_not_compile and panics.
  • Drop the ignore annotation wherever possible, so that the examples, including non-compiling or panicking ones, are checked to behave as expected.
  • Add should_panic or compile_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 both compile_fail or should_panic and ignore, so that it would be now easy to grep for them during future changes.

@carols10cents carols10cents added this to the all milestone Dec 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants