From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Wed, 17 Feb 2021 00:42:55 +0000 (+0000)
Subject: hidden: recalculate: more doc comments
X-Git-Tag: otter-0.4.0~429
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=4d2a7d58f1caccfd2d7570db00b9be2e1ef2fc37;p=otter.git

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 3a1e9aab..2ba2811b 100644
--- 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