[bitboard] Add a doc comment to BitBoard::first_occupied_square

This commit is contained in:
Eryn Wells 2025-07-12 20:20:04 -07:00
parent d3c94356bd
commit 5444d8ea3a

View file

@ -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 {