document Value::{Unknown,Nil}

1 files changed, 3 insertions, 0 deletions

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,
 }