Update docs

src/event.rs

@@ -20,6 +20,7 @@ pub struct EventHandler {
 }
 
 impl EventHandler {
+    /// Create a new event handler with the specified tick rate.
     pub fn new(tick_rate: u64) -> Self {
         let tick_rate = Duration::from_millis(tick_rate);
         let (sender, receiver) = mpsc::channel();

src/file.rs

@@ -4,13 +4,16 @@ use std::{
     path::Path,
 };
 
+/// Read the contents of a file into a vector of bytes.
 pub fn read_file<P: AsRef<Path>>(path: P) -> io::Result<Vec<u8>> {
     let mut file = File::open(path)?;
     let mut buffer = Vec::new();
     file.read_to_end(&mut buffer)?;
     Ok(buffer)
 }
 
+/// Compare two files and return a vector of tuples containing the index of the
+/// differing byte and the byte itself.
 pub fn diff_files(file1: &[u8], file2: &[u8]) -> Vec<(usize, u8)> {
     file1
         .iter()

src/handler.rs

@@ -2,6 +2,7 @@ use crossterm::event::{KeyCode, KeyEvent};
 
 use crate::{app::App, tui::TerminalSize};
 
+/// Handle key events and update the app state accordingly.
 pub fn handle_key_events(
     key_event: KeyEvent,
     app: &mut App,

src/tui.rs

@@ -12,9 +12,7 @@ use std::panic;
 /// Representation of a terminal user interface.
 #[derive(Debug)]
 pub struct Tui<B: Backend> {
-    /// Interface to the Terminal.
     terminal: Terminal<B>,
-    /// Terminal event handler.
     pub events: EventHandler,
 }
 

src/ui.rs

@@ -8,6 +8,7 @@ use ratatui::{
 
 use crate::app::App;
 
+/// Render the user interface.
 pub fn render(app: &mut App, frame: &mut Frame) {
     let size = frame.size();