Skip to content

Test examples in extended diagnostics #27328

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
Closed
brson opened this issue Jul 27, 2015 · 4 comments · Fixed by #30726
Closed

Test examples in extended diagnostics #27328

brson opened this issue Jul 27, 2015 · 4 comments · Fixed by #30726
Labels
A-testsuite Area: The testsuite used to check the correctness of rustc T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@brson
Copy link
Contributor

brson commented Jul 27, 2015

The extended error explanations are filled with amazing examples, but they are not validated in any way.

Having these tested would be a great extension to the test suite and ensure that they do not become misleading as they bitrot.

Since many of these examples don't compile, we might need to improve rustdoc's testing of compile failures.

cc @GuillaumeGomez @steveklabnik
@brson brson added A-testsuite Area: The testsuite used to check the correctness of rustc A-build T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jul 27, 2015
@brson
Copy link
Contributor Author

brson commented Jul 27, 2015

cc @michaelsproul @nikomatsakis

@brson
Copy link
Contributor Author

brson commented Sep 29, 2015

Once we have compile-fail tests for docs there are a bunch of examples in the docs that can be tested.

For now, we can not deal with unstable features in compile-fail tests and continue to ignore such examples.

@michaelsproul
Copy link
Contributor

Interesting! I've been pretty busy with uni-related stuff but I'll have more Rust time in a month or so!

@GuillaumeGomez
Copy link
Member

I'm starting to work on it.

@GuillaumeGomez GuillaumeGomez mentioned this issue Jan 6, 2016
Merged
bors added a commit that referenced this issue Feb 12, 2016
@bors
Auto merge of #30726 - GuillaumeGomez:compile-fail, r=brson
ce4b75f 
r? @brson
cc @alexcrichton

I still need to add error code explanation test with this, but I can't figure out a way to generate the `.md` files in order to test example source codes.

Will fix #27328.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-testsuite Area: The testsuite used to check the correctness of rustc 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.

Add compile-fail test in rustdoc GuillaumeGomez/rust
5 participants
@steveklabnik @alexcrichton @brson @GuillaumeGomez @michaelsproul