This repository has been archived by the owner on Oct 22, 2019. It is now read-only.
Improves the documentation #4
Merged
Conversation
This file contains 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
Signed-off-by: Robert Vojta <[email protected]>
Signed-off-by: Robert Vojta <[email protected]>
Signed-off-by: Robert Vojta <[email protected]>
43 tasks
TimonPost
approved these changes
Oct 1, 2019
| pub struct AsyncReader { | ||
| event_rx: Receiver<u8>, | ||
| shutdown: Arc<AtomicBool>, | ||
| } | ||
|
|
||
| impl AsyncReader { | ||
| /// Construct a new instance of the `AsyncReader`. | ||
| /// The reading will immediately start when calling this function. | ||
| // TODO Should the new() really be public? |
There was a problem hiding this comment.
Nope, it can be pub(crate), however, let's move those to input idea issue and discuss it over there.
Signed-off-by: Robert Vojta <[email protected]>
Signed-off-by: Robert Vojta <[email protected]>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
AsyncReader/SyncReaderdocumentation in thewindowsmodule is a copy & paste of the documentation from theunixmodule. Both are public. There's a TODO inside to fix/update this.