From 66f55416e2b247e50545c27a3cfe8a2bf4153e10 Mon Sep 17 00:00:00 2001
From: Nick Krichevsky <nick@ollien.com>
Date: Sat, 4 Dec 2021 23:14:36 -0500
Subject: [PATCH] Clarify comments in day 4

---
 day4/src/main.rs | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/day4/src/main.rs b/day4/src/main.rs
index 07f3b26..eb8b0c5 100644
--- a/day4/src/main.rs
+++ b/day4/src/main.rs
@@ -37,12 +37,13 @@ struct BoardState {
     board: BingoBoard,
 }
 
+/// `BingoGame` represents an active game of bingo and its state.
 struct BingoGame {
     calls: VecDeque<u8>,
     boards: Vec<BoardState>,
 }
 
-/// `BingoPlayer` is an iterator that will iterate over the successive winners of a bingo game.
+/// `BingoPlayer` is an iterator that will iterate over the successive winners of a `BingoGame`
 struct BingoPlayer<'a> {
     game: &'a mut BingoGame,
 }