From ec7c8371e427e1245735f5bf729927712f496470 Mon Sep 17 00:00:00 2001 From: Ian Jackson Date: Sun, 25 Apr 2021 18:13:40 +0100 Subject: [PATCH] hidden: Document ShowUnocculted proof obligations Signed-off-by: Ian Jackson --- src/hidden.rs | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) 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, -- 2.30.2