From 7438b2c9e5e218895fffdcb5993e013f1ca226aa Mon Sep 17 00:00:00 2001 From: Ava Hahn Date: Wed, 8 Mar 2023 12:09:20 -0800 Subject: [PATCH] yet more docs --- Readme.org | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/Readme.org b/Readme.org index b394019..e0ac447 100644 --- a/Readme.org +++ b/Readme.org @@ -8,7 +8,7 @@ The purpose of Relish is to create a highly portable, easy to integrate language * Goals - Iterate on the ideas and designs that were tested with SHS -https://gitlab.com/whom/shs + https://gitlab.com/whom/shs - Create a usable POSIX shell - Create usable applications/scripts - To have quality code coverage @@ -21,7 +21,7 @@ https://gitlab.com/whom/shs * Contact - Matrix chat: #vomitorium:matrix.sunnypup.io -https://matrix.to/#/#vomitorium:matrix.sunnypup.io + https://matrix.to/#/#vomitorium:matrix.sunnypup.io * How to use ** Syntax @@ -103,6 +103,34 @@ Like the *if form*, if the conditional returns a non-boolean value the *while lo **** TODO let **** TODO circuit +**** not quite control flow +Several other functions use lazy evaluation of their arguments. The below list is non-exhaustive: +- toggle +- inc +- dec + +These functions are mentioned here for their use with control flow. +- inc: increment a symbol by one +- dec: decrement a symbol by one +- toggle: flip a symbol from true to false, or vice versa + +For more information on these functions consult the output of the help function: +#+BEGIN_SRC lisp +λ (help toggle) +NAME: toggle + +ARGS: 1 args of any type + +DOCUMENTATION: + +switches a boolean symbol between true or false. +Takes a single argument (a symbol). Looks it up in the variable table. +Either sets the symbol to true if it is currently false, or vice versa. + +CURRENT VALUE AND/OR BODY: + +#+END_SRC + *** TODO quote and eval *** TODO Defining variables and functions **** TODO Anatomy