documentation and cargo.toml changes

Cargo.toml

@@ -2,6 +2,9 @@
 name = "lamm"
 version = "0.1.0"
 edition = "2021"
+license = "MIT"
+description = "a simple, functional paradigm programming language which uses Polish notation"
+repository = "https://github.com/minneelyyyy/lamm"
 
 [dependencies]
 regex = "1.11"

src/executor.rs

@@ -60,6 +60,7 @@ enum Object {
     Function(Function),
 }
 
+/// Executes an input of ParseTrees
 pub struct Executor<I: Iterator<Item = Result<ParseTree, ParseError>>> {
     exprs: I,
     globals: HashMap<String, Object>,

src/lib.rs

@@ -34,6 +34,7 @@ impl Display for Type {
     }
 }
 
+/// Represents the result of executing a ParseTree with an Executor
 #[derive(Clone, Debug, PartialEq)]
 pub enum Value {
     Float(f64),

src/parser.rs

@@ -239,6 +239,7 @@ impl ParseTree {
     }
 }
 
+/// Parses input tokens and produces ParseTrees for an Executor
 pub struct Parser<I: Iterator<Item = Result<Token, TokenizeError>>> {
     tokens: I,
 

src/tokenizer.rs

@@ -148,6 +148,7 @@ impl Token {
     }
 }
 
+/// Tokenize an input stream of source code for a Parser
 pub struct Tokenizer<R: BufRead> {
     reader: R,
     tokens: VecDeque<Token>,