sforman/Thun
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor docs update.

Browse Source
This commit is contained in:
Simon Forman
2019-12-02 14:13:50 -08:00
parent eb591d27e0
commit 57446a1179
2 changed files with 15 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
joy/joy.py
+8 -5
View File
@@ -35,12 +35,15 @@ from .utils.pretty_print import TracePrinter
def joy(stack, expression, dictionary, viewer=None):
'''Evaluate the Joy expression on the stack.
'''Evaluate a Joy expression on a stack.
The basic joy() function is quite straightforward. It iterates through a
sequence of terms which are either literals (strings, numbers, sequences)
or functions. Literals are put onto the stack and functions are
executed.
This function iterates through a sequence of terms which are either
literals (strings, numbers, sequences of terms) or function symbols.
Literals are put onto the stack and functions are looked up in the
disctionary and executed.
The viewer is a function that is called with the stack and expression
on every iteration, its return value is ignored.
:param stack stack: The stack.
:param stack expression: The expression to evaluate.