aboutsummaryrefslogtreecommitdiff
path: root/alacritty_terminal/src/event.rs
diff options
context:
space:
mode:
authorChristian Duerr <contact@christianduerr.com>2020-05-05 22:50:23 +0000
committerGitHub <noreply@github.com>2020-05-05 22:50:23 +0000
commit81ce93574f62d4b117fdd79af65391f30316a457 (patch)
tree951a0578860c6028e2dfff0ca83879001c6b2385 /alacritty_terminal/src/event.rs
parent04f0bcaf54ed373128ca0f84ee8fcdd8e52bce23 (diff)
downloadalacritty-81ce93574f62d4b117fdd79af65391f30316a457.tar.gz
alacritty-81ce93574f62d4b117fdd79af65391f30316a457.zip
Extend style guideline documentation
Diffstat (limited to 'alacritty_terminal/src/event.rs')
-rw-r--r--alacritty_terminal/src/event.rs10
1 files changed, 5 insertions, 5 deletions
diff --git a/alacritty_terminal/src/event.rs b/alacritty_terminal/src/event.rs
index c8edae1e..68a3282e 100644
--- a/alacritty_terminal/src/event.rs
+++ b/alacritty_terminal/src/event.rs
@@ -16,20 +16,20 @@ pub enum Event {
Exit,
}
-/// Byte sequences are sent to a `Notify` in response to some events
+/// Byte sequences are sent to a `Notify` in response to some events.
pub trait Notify {
- /// Notify that an escape sequence should be written to the pty
+ /// Notify that an escape sequence should be written to the PTY.
///
- /// TODO this needs to be able to error somehow
+ /// TODO this needs to be able to error somehow.
fn notify<B: Into<Cow<'static, [u8]>>>(&mut self, _: B);
}
-/// Types that are interested in when the display is resized
+/// Types that are interested in when the display is resized.
pub trait OnResize {
fn on_resize(&mut self, size: &SizeInfo);
}
-/// Event Loop for notifying the renderer about terminal events
+/// Event Loop for notifying the renderer about terminal events.
pub trait EventListener {
fn send_event(&self, event: Event);
}