yet more docs

This commit is contained in:
Ava Hahn 2023-03-08 12:09:20 -08:00
parent 896ed567fd
commit 7438b2c9e5
Signed by untrusted user who does not match committer: affine
GPG key ID: 3A4645B8CF806069

View file

@ -8,7 +8,7 @@ The purpose of Relish is to create a highly portable, easy to integrate language
* Goals * Goals
- Iterate on the ideas and designs that were tested with SHS - 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 a usable POSIX shell
- Create usable applications/scripts - Create usable applications/scripts
- To have quality code coverage - To have quality code coverage
@ -21,7 +21,7 @@ https://gitlab.com/whom/shs
* Contact * Contact
- Matrix chat: #vomitorium:matrix.sunnypup.io - Matrix chat: #vomitorium:matrix.sunnypup.io
https://matrix.to/#/#vomitorium:matrix.sunnypup.io https://matrix.to/#/#vomitorium:matrix.sunnypup.io
* How to use * How to use
** Syntax ** Syntax
@ -103,6 +103,34 @@ Like the *if form*, if the conditional returns a non-boolean value the *while lo
**** TODO let **** TODO let
**** TODO circuit **** 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:
<builtin>
#+END_SRC
*** TODO quote and eval *** TODO quote and eval
*** TODO Defining variables and functions *** TODO Defining variables and functions
**** TODO Anatomy **** TODO Anatomy