From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Sun, 31 Jan 2021 23:07:32 +0000 (+0000)
Subject: hidden: Document the convention about last face
X-Git-Tag: otter-0.4.0~570
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=8436120d124c0c148ef68b51dac3c31ed27527df;p=otter.git

hidden: Document the convention about last face

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

diff --git a/src/gamestate.rs b/src/gamestate.rs
index d50baaed..1a308d52 100644
--- a/src/gamestate.rs
+++ b/src/gamestate.rs
@@ -122,6 +122,7 @@ pub struct UoDescription {
 
 #[typetag::serde]
 pub trait Piece: Outline + Send + Debug {
+  /// by convention, occult face is nfaces-1
   fn nfaces(&self) -> RawFaceId;
 
   #[throws(InternalError)]