Document event_loop_factory usage #15576
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -166,8 +166,13 @@ | |||
| //! ```rust | |||
| //! use std::task::TaskBuilder; | |||
| //! use green::{SchedPool, PoolConfig, GreenTaskBuilder}; | |||
| //! use rustuv; | |||
There was a problem hiding this comment.
Won't this need an extern crate rustuv declaration as well?
There was a problem hiding this comment.
Meant to type extern crate and not use, good spot.
There was a problem hiding this comment.
The test case is also auto-wrapped in fn main() where extern crate definitions aren't allowed, so you'll have to add a secret fn main() wrapper yourself. I'd recommend running rustdoc --test just to make sure it checks out.
There was a problem hiding this comment.
Cleaned up and fixed :)
Add a couple of lines mentioning event_loop_factory - no clear error message is given if you attempt to perform I/O in tasks created in this fashion.
bors
added a commit
that referenced
this pull request
Jul 11, 2014
Add a couple of lines mentioning event_loop_factory - no clear error message is given if you attempt to perform I/O in tasks created in this fashion. I spent a many hours debugging this yesterday which would have been avoided if it were documented.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a couple of lines mentioning event_loop_factory - no clear error message is given if you attempt to perform I/O in tasks created in this fashion. I spent a many hours debugging this yesterday which would have been avoided if it were documented.