-
Notifications
You must be signed in to change notification settings - Fork 13.3k
Clarify in the book when rustdoc tests are run #24228
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
Why do we run them on Would be nice to know in order to write the docs.
|
I have no idea, in the discussion in the IRC we just did not really have any reasoning. (But I'm a rust noob :) ) |
steveklabnik
added a commit
to steveklabnik/rust
that referenced
this issue
Apr 16, 2015
steveklabnik
added a commit
to steveklabnik/rust
that referenced
this issue
Apr 16, 2015
steveklabnik
added a commit
to steveklabnik/rust
that referenced
this issue
Apr 17, 2015
Manishearth
added a commit
to Manishearth/rust
that referenced
this issue
Apr 17, 2015
Manishearth
added a commit
to Manishearth/rust
that referenced
this issue
Apr 17, 2015
GuillaumeGomez
pushed a commit
to GuillaumeGomez/rust
that referenced
this issue
Apr 17, 2015
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The new chapter on documentation is great, but in my opinion the documentation tests are still missleading.
When you
cargo new --bin mycrate
cargo test
it will not run this doctest, only if the create was created without the
--bin
flag. This behaviour is documented in the crates manifest but this should be noted directly in the book. Particularly as I think, most readers of the book will play around with a project with a main.rs but not with a lib.rs.The text was updated successfully, but these errors were encountered: