[bitboard] Add a doc comment to BitBoard::first_occupied_square
This commit is contained in:
		
							parent
							
								
									d3c94356bd
								
							
						
					
					
						commit
						5444d8ea3a
					
				
					 1 changed files with 6 additions and 0 deletions
				
			
		| 
						 | 
				
			
			@ -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 {
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue