hidden: recalculate: more doc comments

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

diff --git a/src/hidden.rs b/src/hidden.rs
index 3a1e9aab2dcbb836f0bf78b15e8ffdc1bb2fd72e..2ba2811b4e70a4c6ee223d6b14ede6293f8cb306 100644 (file)
--- a/src/hidden.rs
+++ b/src/hidden.rs
@@ -224,9 +224,13 @@ fn recalculate_occultation_general<
   who_by: Html,
   ipieces: &PiecesLoaded,
   piece: PieceId,
+  // if no change, we return ret_vanilla(log_visible)
   log_visible: LD,
   ret_vanilla: VF,
+  // otherwise we maybe call log_callback(who_by, old, new, desc)
+  // or maybe we just use log_visible
   log_callback: LF,
+  // and then call ret_callback(<calculated>, <logmsgs>)
   ret_callback: RF,
 )
   -> RD