From 317b3e732bca9f0a78cc914fc69010c5aa32c2b4 Mon Sep 17 00:00:00 2001 From: Linus Date: Wed, 16 Dec 2020 19:59:03 +0100 Subject: [PATCH] Fix markdown in README.md to not show like HTML. --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 2ff0521..7efc8b3 100644 --- a/README.md +++ b/README.md @@ -161,32 +161,32 @@ A goof loop expands into something looking like this: (goof-loop ... ...))) ``` -: are provided by accumulators or for clauses for bindings that are not passed as an argument to the loop, for example a vector. The vector is bound here, and the index into the vector is the thing iterated over. +<outer-let>: are provided by accumulators or for clauses for bindings that are not passed as an argument to the loop, for example a vector. The vector is bound here, and the index into the vector is the thing iterated over. - and : When the iteration ends, this function is called with the results of the :acc clauses. In the case of (:acc lst-acc (listing ...)), the name of the accumulator is never lst-acc in the loop body, but only in the . In case of (listing ...) the accumulated results are reversed before the final function. +<final-binding> and <final-expr>: When the iteration ends, this function is called with the results of the :acc clauses. In the case of (:acc lst-acc (listing ...)), the name of the accumulator is never lst-acc in the loop body, but only in the <final-expr>. In case of (listing ...) the accumulated results are reversed before the final function. - and : holds the current state of an accumulator clause. This is not necessarily the same binding as the user provided as the name, as described above. is the current state of a :for clause. +<accumulator> and <loop-variable>: <accumulator> holds the current state of an accumulator clause. This is not necessarily the same binding as the user provided as the name, as described above. <loop-var> is the current state of a :for clause. -: Checks for :for-clauses. In the case of (in-list ...) this would check for (not (pair? ...)). +<check>: Checks for :for-clauses. In the case of (in-list ...) this would check for (not (pair? ...)). -: some :for clauses need to be finalized. In the case of (in-file ...) the open file handle is closed at any point where the iteration stops. +<for-clause-finalizer>: some :for clauses need to be finalized. In the case of (in-file ...) the open file handle is closed at any point where the iteration stops. -: is any preprocessing done to before passing it on to the final-function. In the case of (listing ...) that would be (reverse ...). +<accumulator-finalizer>: <accumulator-finalizer> is any preprocessing done to <accumulator> before passing it on to the final-function. In the case of (listing ...) that would be (reverse ...). - and : are the names the user provided for the body bindings. In the case of (:for a (in-list '(1 2 3))) the body binding would be (a (car name-of-loop-variable)). The body binding may be an (ice-9 match) pattern. More on that below. +<body-binding> and <body-binding-expr>:<body-binding> are the names the user provided for the body bindings. In the case of (:for a (in-list '(1 2 3))) the body binding would be (a (car name-of-loop-variable)). The body binding may be an (ice-9 match) pattern. More on that below. - and : If a is not an identifier, it is presumed to be a match-let pattern. The result is bound to a variable and matched against this match-let. +<parenthesised-pattern> and <match-expr>: If a <user-binding> is not an identifier, it is presumed to be a match-let pattern. The result is bound to a variable and matched against this match-let. -: the user supplied :when or :unless guard expression. +<when-expr>: the user supplied :when or :unless guard expression. -: user-supplied :break guard. +<user-break>: user-supplied :break guard. -, , and : The user supplied body of the loop. If the loop is not named (i.e: in loops where the user controls the iteration) an expression for the next loop iteration is added to the body. is the expression the accumulator clause provided to accumulate a new value. For (:acc acc (listing elem)) that is (cons elem acc). is the expression evaluated to get the next iteration's loop variable. In the case of (in-list lst) that is (cdr lst). If a loop name is provided there is no implicit next loop. +<loop-body>, <accumulate>, and <loop-var-next>: The user supplied body of the loop. If the loop is not named (i.e: in loops where the user controls the iteration) an expression for the next loop iteration is added to the body. <accumulate> is the expression the accumulator clause provided to accumulate a new value. For (:acc acc (listing elem)) that is (cons elem acc). <loop-var-next> is the expression evaluated to get the next iteration's loop variable. In the case of (in-list lst) that is (cdr lst). If a loop name is provided there is no implicit next loop. - and : are ALL accumulator init values, including the ones in subloops. For (listing ...) that is the empty list. is the initial loop vars. +<accumulator-init> and <loop-var-init>: <accumulator-init> are ALL accumulator init values, including the ones in subloops. For (listing ...) that is the empty list. <loop-var-init> is the initial loop vars. -In case of subloops, those are placed instead of . They use the same final-function, and instead of quitting when any triggers they go out to the outer loop. +In case of subloops, those are placed instead of <loop-body>. They use the same final-function, and instead of quitting when any <check> triggers they go out to the outer loop. ### Speed