From 5444d8ea3a58842c880db1a79a84f2d9fda700e2 Mon Sep 17 00:00:00 2001
From: Eryn Wells <eryn@erynwells.me>
Date: Sat, 12 Jul 2025 20:20:04 -0700
Subject: [PATCH] [bitboard] Add a doc comment to
 BitBoard::first_occupied_square

---
 bitboard/src/bitboard.rs | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/bitboard/src/bitboard.rs b/bitboard/src/bitboard.rs
index 6eb63eb..ccee9bd 100644
--- a/bitboard/src/bitboard.rs
+++ b/bitboard/src/bitboard.rs
@@ -287,6 +287,12 @@ impl BitBoard {
         }
     }
 
+    /// Get the first occupied square in the given direction.
+    ///
+    /// ## To-Do
+    ///
+    /// - Take `direction` by value instead of reference
+    ///
     #[must_use]
     pub fn first_occupied_square(&self, direction: &IterationDirection) -> Option<Square> {
         match direction {