-
Notifications
You must be signed in to change notification settings - Fork 13.3k
rustdoc --test
fails for simple examples in macro doc-comments.
#23571
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
Comments
This is really a documentation bug. First, we need to document that you have to explicitly link your macros when writing doctests for them. Second, because linking can only be done at a crate root and because rustdoc will implicitly wrap your test in a |
Here's how the original gist looks when updated with the changes described above: https://gist.github.com/bstrie/653bc834aa871b8f45fa Doubly misleading is that it's no use reading the stdlib when trying to figure out the cause of this test failure, because the implict linking of the std macros masks the need for manual linking. |
Fixes rust-lang#23571 I _think_ this is better, but other suggestions welcome too.
Fixes rust-lang#23571 I _think_ this is better, but other suggestions welcome too.
This gist contains a short, sweet, and simple reduced case.
The text was updated successfully, but these errors were encountered: