-
Notifications
You must be signed in to change notification settings - Fork 273
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
Update examples in top-level readme. #588
Conversation
//! .start(&"127.0.0.1:3030".parse().unwrap()) | ||
//! .expect("Unable to start TCP server"); | ||
//! | ||
//! // server.wait(); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"uncommented" because the example wouldn't terminate otherwise?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, is there some other way to prevent that? I guess we could mark it as "no-run"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess we could either mark it no_run
or hide the "uncommented" line from the docs by # // server.wait();
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no_run
feels inferior, since it won't detect the runtime errors- I think hidden lines are still being executed (they are just not displayed in the example)
I can remove the comment completely, but I think it's easier if we make users aware they have to wait for the server. Can add an explanation comment.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can add an explanation comment.
Yes please. :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added.
//cc @dvdplm @maciejhirsz need 1 more review :) |
Closes #586