commit 836c58d5b4dbf8c9639ac612e1f7d8f49dd825c8
parent cb3f99dbfec0419643248f288823214f7f52ac33
Author: Ed van Bruggen <edvb@uw.edu>
Date: Mon, 28 Jan 2019 23:57:23 -0800
Add more primitive's documentation
Diffstat:
2 files changed, 33 insertions(+), 5 deletions(-)
diff --git a/doc/tisp.1 b/doc/tisp.1
@@ -4,7 +4,7 @@
tisp \- tiny lisp
.PP
.SH SYNOPSIS
-tisp [-hv] [FILENAME]
+tisp [-hv] [FILE ...]
.PP
.SH DESCRIPTION
.PP
@@ -120,18 +120,34 @@ Return rest of the given list, either just the second element if it is of size 2
Creates a new pair with the two given arguments, first one as the car, second as the cdr.
.PP
.TP
-\fB=\fP
-Tests if multiple values equal. Returns nil if any are not, and 't' otherwise.
-.PP
-.TP
\fBquote\fP
Returns the given argument unevaluated.
.PP
.TP
+\fBvoid\fP
+Returns nothing. Used to insert a void type in a list or force a function not to return anything.
+.PP
+.TP
+\fBbegin\fP
+Executes all of its arguments and returns the value of the last expression.
+.PP
+.TP
+\fBeval\fP
+Evaluates the expression given.
+.PP
+.TP
+\fB=\fP
+Tests if multiple values equal. Returns nil if any are not, and 't' otherwise.
+.PP
+.TP
\fBcond\fP
Evaluates each expression if the given condition corresponding to it is true. Runs through any arguments, each is a list with the first element as the condition which needs to be 't' after evaluated, and the second element is the expression to be run if and only if the condition is met.
.PP
.TP
+\fBtype\fP
+Returns a string stating the given argument's type.
+.PP
+.TP
\fBlambda\fP
Creates function, first argument is a list of elements representing the symbol name for any arguments for the new function. Next argument is code to be run with the supplied arguments.
.PP
diff --git a/doc/tisp.1.md b/doc/tisp.1.md
@@ -149,6 +149,14 @@ Returns the given argument unevaluated.
Returns nothing. Used to insert a void type in a list or force a function not
to return anything.
+#### begin
+
+Executes all of its arguments and returns the value of the last expression.
+
+#### eval
+
+Evaluates the expression given.
+
#### =
Tests if multiple values equal. Returns nil if any are not, and `t` otherwise.
@@ -160,6 +168,10 @@ Runs through any arguments, each is a list with the first element as the
condition which needs to be `t` after evaluated, and the second element is the
expression to be run if and only if the condition is met.
+#### type
+
+Returns a string stating the given argument's type.
+
#### lambda
Creates function, first argument is a list of elements representing the symbol