From 5403fd849cfb0f6f93e4008705ac4a993c2cd923 Mon Sep 17 00:00:00 2001
From: link2xt <link2xt@testrun.org>
Date: Sun, 16 Apr 2023 00:20:37 +0000
Subject: [PATCH] Comment fixes

---
 src/context.rs | 4 ++--
 src/events.rs  | 6 ++++--
 2 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/src/context.rs b/src/context.rs
index 3245a6ff7..833e68e9f 100644
--- a/src/context.rs
+++ b/src/context.rs
@@ -253,8 +253,8 @@ pub(crate) struct DebugLogging {
     pub(crate) msg_id: MsgId,
     /// Handle to the background task responsible for sending
     pub(crate) loop_handle: task::JoinHandle<()>,
-    /// Channel that log events should be send to
-    /// A background loop will receive and handle them
+    /// Channel that log events should be sent to.
+    /// A background loop will receive and handle them.
     pub(crate) sender: Sender<DebugEventLogData>,
 }
 
diff --git a/src/events.rs b/src/events.rs
index ebb1d299f..ade9fe8db 100644
--- a/src/events.rs
+++ b/src/events.rs
@@ -32,7 +32,9 @@ impl Events {
         Self { receiver, sender }
     }
 
-    /// Emits an event.
+    /// Emits an event into event channel.
+    ///
+    /// If the channel is full, deletes the oldest event first.
     pub fn emit(&self, event: Event) {
         match self.sender.try_send(event) {
             Ok(()) => {}
@@ -49,7 +51,7 @@ impl Events {
         }
     }
 
-    /// Retrieve the event emitter.
+    /// Creates an event emitter.
     pub fn get_emitter(&self) -> EventEmitter {
         EventEmitter(self.receiver.clone())
     }