Update examples in top-level readme. #588
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
niklasad1
reviewed
Sep 24, 2020
| //! .start(&"127.0.0.1:3030".parse().unwrap()) | ||
| //! .expect("Unable to start TCP server"); | ||
| //! | ||
| //! // server.wait(); |
Contributor
There was a problem hiding this comment.
"uncommented" because the example wouldn't terminate otherwise?
Contributor
Author
There was a problem hiding this comment.
Yes, is there some other way to prevent that? I guess we could mark it as "no-run"?
Contributor
There was a problem hiding this comment.
I guess we could either mark it no_run or hide the "uncommented" line from the docs by # // server.wait();
Contributor
Author
There was a problem hiding this comment.
no_runfeels 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.
Contributor
There was a problem hiding this comment.
Can add an explanation comment.
Yes please. :)
niklasad1
approved these changes
Sep 24, 2020
Contributor
|
//cc @dvdplm @maciejhirsz need 1 more review :) |
dvdplm
approved these changes
Nov 6, 2020
This was referenced Mar 12, 2021
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.
Closes #586