From 8099326d637928f2daffd38aee0602c23582b788 Mon Sep 17 00:00:00 2001
From: Simon Gardling <titaniumtown@proton.me>
Date: Tue, 28 Jan 2025 11:57:16 -0500
Subject: [PATCH] add docs for `propegate_from`

---
 src/repr.rs | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/src/repr.rs b/src/repr.rs
index a053589..ccdfbcd 100644
--- a/src/repr.rs
+++ b/src/repr.rs
@@ -72,7 +72,9 @@ impl Board {
         *self.get_mut(i, j) = Some(piece);
     }
 
-    // TODO! make this better and actually readable
+    /// Propegate piece captures originating from (i, j)
+    /// DO NOT USE THIS ALONE, this should be called as a part of
+    /// [`Board::place`] or [`Board::place_and_prop_unchecked`]
     fn propegate_from(&mut self, i: usize, j: usize) {
         // returns if that place is empty
         let Some(starting_color) = *self.get(i, j) else {