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

Document the rules for extern crate in doc tests #28082

Closed
astraw opened this issue Aug 29, 2015 · 1 comment
Closed

Document the rules for extern crate in doc tests #28082

astraw opened this issue Aug 29, 2015 · 1 comment

Comments

@astraw
Copy link
Contributor

astraw commented Aug 29, 2015

It's not clear from the documentation how to use external crates in doc tests. This should be documented in the testing section of the book.

This is related to rust-lang/cargo#960.
@astraw astraw mentioned this issue Aug 29, 2015
Closed
astraw added a commit to astraw/rust that referenced this issue Aug 29, 2015
@astraw
Document the rules for in doc tests
602e8da 
This fixes rust-lang#28082
@astraw
Copy link
Contributor Author

astraw commented Aug 29, 2015

Now I see that this is actually described in the documentation chapter here. However, I was looking at the testing chapter here. So the bug report should now be changed to "cross-referece the doctest part of the documentation chapter from the doctest part of the testing chapter" since I completely missed the relevant section despite looking for it rather extensively.

steveklabnik added a commit to steveklabnik/rust that referenced this issue Sep 30, 2015
@steveklabnik
Cross-reference doc chapter from testing chapter
201384c 
We don't completely cover documentation tests in the testing chapter,
since we cover them in the documentation chapter. So make sure people
know that.

Fixes rust-lang#28082
@steveklabnik steveklabnik mentioned this issue Sep 30, 2015
Merged
steveklabnik added a commit to steveklabnik/rust that referenced this issue Sep 30, 2015
@steveklabnik
Rollup merge of rust-lang#28761 - steveklabnik:gh28082, r=brson
64796d1 
We don't completely cover documentation tests in the testing chapter,
since we cover them in the documentation chapter. So make sure people
know that.

Fixes rust-lang#28082
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Document the rules for extern crate in doc tests astraw/rust
2 participants
@steveklabnik @astraw