From 1ccd9b3f2ffa449a11f2348314f0dcae2e224c6b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= <gustav@sornas.net>
Date: Sun, 7 Mar 2021 23:42:42 +0100
Subject: document Value::{Unknown,Nil}

---
 src/lib.rs | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'src')

diff --git a/src/lib.rs b/src/lib.rs
index 5094698..7e09dce 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -178,7 +178,10 @@ pub enum Value {
     String(Rc<String>),
     Function(Vec<Rc<RefCell<UpValue>>>, Rc<RefCell<Block>>),
     ExternFunction(usize),
+    /// This value should not be present when running, only when type checking.
+    /// Most operations are valid but produce funky results.
     Unknown,
+    /// Should not be present when running.
     Nil,
 }
 
-- 
cgit v1.2.1