Skip to content
This repository has been archived by the owner on Oct 22, 2019. It is now read-only.

Improves the documentation #4

Merged
merged 5 commits into from
Oct 1, 2019
Merged

Improves the documentation #4

merged 5 commits into from
Oct 1, 2019

Conversation

zrzka
Copy link
Contributor

@zrzka zrzka commented Oct 1, 2019

  • Sync the documentation style (README, ...)
  • Proper documentation of the public API
  • One note, AsyncReader/SyncReader documentation in the windows module is a copy & paste of the documentation from the unix module. Both are public. There's a TODO inside to fix/update this.

Signed-off-by: Robert Vojta <rvojta@me.com>
Signed-off-by: Robert Vojta <rvojta@me.com>
Signed-off-by: Robert Vojta <rvojta@me.com>
Copy link
Member

@TimonPost TimonPost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So far so good

CHANGELOG.md Show resolved Hide resolved
src/input.rs Outdated Show resolved Hide resolved
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?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 <rvojta@me.com>
Signed-off-by: Robert Vojta <rvojta@me.com>
@zrzka zrzka merged commit 7efd3b0 into master Oct 1, 2019
@zrzka zrzka deleted the zrzka/docs-update branch October 1, 2019 13:17
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants