From cc3d1b3d95a0061d349d143f8f9565db9ced0401 Mon Sep 17 00:00:00 2001
From: Simon Gardling <titaniumtown@proton.me>
Date: Fri, 7 Feb 2025 15:40:19 -0500
Subject: [PATCH] add comment about `problem_space`

---
 src/complexagent.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/complexagent.rs b/src/complexagent.rs
index 307af6c..852445a 100644
--- a/src/complexagent.rs
+++ b/src/complexagent.rs
@@ -79,6 +79,8 @@ impl Move {
     }
 }
 
+/// Take a [`Board`] and a [`Piece`] color and give all possible moves for that color on the board
+/// Returns a Boxed iterator to be used in other logic
 fn problem_space(board: &Board, color: Piece) -> Box<dyn Iterator<Item = Move> + '_> {
     Box::new(
         board