From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Sun, 25 Apr 2021 17:13:40 +0000 (+0100)
Subject: hidden: Document ShowUnocculted proof obligations
X-Git-Tag: otter-0.6.0~523
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=ec7c8371e427e1245735f5bf729927712f496470;p=otter.git

hidden: Document ShowUnocculted proof obligations

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

diff --git a/src/hidden.rs b/src/hidden.rs
index 01a0227d..31f165bd 100644
--- a/src/hidden.rs
+++ b/src/hidden.rs
@@ -17,6 +17,9 @@ visible_slotmap_key!{ OccId(b'H') }
 // ========== data structures ==========
 
 #[derive(Copy,Clone,Debug)]
+/// Proof token.
+///
+/// Proof obligation when constructing.
 pub struct ShowUnocculted(());
 
 #[derive(Copy,Clone,Debug)]
@@ -358,14 +361,16 @@ impl OccDisplacement {
 }
 
 impl ShowUnocculted {
-  /// override
+  /// Override.  Proof obligation: this context does not require
+  /// honouring occultation.
   pub const fn new_visible() -> ShowUnocculted {
     ShowUnocculted(())
   }
 }
 
 impl PieceRenderInstructions {
-  /// override
+  /// Override.  Proof obligation: this context does not require
+  /// honouring occultation.
   pub fn new_visible(vpid: VisiblePieceId) -> PieceRenderInstructions {
     PieceRenderInstructions {
       vpid,