From c8481d35c120ff99213e6ed73ba889e51cac10c5 Mon Sep 17 00:00:00 2001
From: mo8it <mo8it@proton.me>
Date: Tue, 14 May 2024 01:49:22 +0200
Subject: Done documentation

---
 src/watch/notify_event.rs | 5 +++--
 src/watch/state.rs        | 9 +++++----
 2 files changed, 8 insertions(+), 6 deletions(-)

(limited to 'src/watch')

diff --git a/src/watch/notify_event.rs b/src/watch/notify_event.rs
index a224377..7471640 100644
--- a/src/watch/notify_event.rs
+++ b/src/watch/notify_event.rs
@@ -3,12 +3,13 @@ use std::sync::mpsc::Sender;
 
 use super::WatchEvent;
 
-pub struct DebounceEventHandler {
+pub struct NotifyEventHandler {
     pub tx: Sender<WatchEvent>,
+    /// Used to report which exercise was modified.
     pub exercise_names: &'static [&'static [u8]],
 }
 
-impl notify_debouncer_mini::DebounceEventHandler for DebounceEventHandler {
+impl notify_debouncer_mini::DebounceEventHandler for NotifyEventHandler {
     fn handle_event(&mut self, input_event: DebounceEventResult) {
         let output_event = match input_event {
             Ok(input_event) => {
diff --git a/src/watch/state.rs b/src/watch/state.rs
index abd21fb..14c3f01 100644
--- a/src/watch/state.rs
+++ b/src/watch/state.rs
@@ -1,7 +1,7 @@
 use anyhow::Result;
 use crossterm::{
     style::{style, Stylize},
-    terminal::size,
+    terminal,
 };
 use std::io::{self, StdoutLock, Write};
 
@@ -84,6 +84,7 @@ impl<'a> WatchState<'a> {
         self.run_current_exercise()
     }
 
+    /// Move on to the next exercise if the current one is done.
     pub fn next_exercise(&mut self) -> Result<ExercisesProgress> {
         if self.done_status == DoneStatus::Pending {
             return Ok(ExercisesProgress::CurrentPending);
@@ -113,7 +114,7 @@ impl<'a> WatchState<'a> {
     }
 
     pub fn render(&mut self) -> Result<()> {
-        // Prevent having the first line shifted.
+        // Prevent having the first line shifted if clearing wasn't successful.
         self.writer.write_all(b"\n")?;
 
         clear_terminal(&mut self.writer)?;
@@ -145,11 +146,11 @@ When you are done experimenting, enter `n` to move on to the next exercise 🦀"
             writeln!(
                 self.writer,
                 "A solution file can be found at {}\n",
-                style(TerminalFileLink(solution_path)).underlined().green()
+                style(TerminalFileLink(solution_path)).underlined().green(),
             )?;
         }
 
-        let line_width = size()?.0;
+        let line_width = terminal::size()?.0;
         let progress_bar = progress_bar(
             self.app_state.n_done(),
             self.app_state.exercises().len() as u16,
-- 
cgit v1.2.3