Document z coordinate sense convention

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

diff --git a/src/gamestate.rs b/src/gamestate.rs
index eb0d114d76aac2dbc55eb530d8e25600272cf9f5..0e6f8751f65cea9ad3a3344521cf663f99ee11f8 100644 (file)
--- a/src/gamestate.rs
+++ b/src/gamestate.rs
@@ -28,6 +28,7 @@ pub struct SpecDepth(u16);
 
 // ---------- general data types ----------
 
+/// Pieces on top have higher values than ones 
 #[derive(Debug,Clone,Eq,PartialEq,Ord,PartialOrd)]
 #[derive(Serialize,Deserialize)]
 pub struct ZLevel {