3 files changed, 22 insertions(+), 20 deletions(-)

M README.md
M src/com/manigfeald/tagbody.clj
M test/com/manigfeald/tagbody_test.clj

@@ 11,6 11,9 @@ http://www.lispworks.com/documentation/HyperSpec/Body/s_tagbod.htm
 ## Usage
 
 ```clojure
+
+(require '[com.manigfeald.tagbody :refer [tagbody go]])
+
 (with-local-vars
   [v nil]
   (tagbody


@@ 30,6 33,23 @@ http://www.lispworks.com/documentation/HyperSpec/Body/s_tagbod.htm
   (var-get v))
 ```
 
+## Limitations
+
+tagbody uses java.lang.Throwables to jump around. This can be
+problematic if you catch Throwables. Exception handles are also single
+threaded, so you cannot go across threads.
+
+The way tagbody currently runs it is limitted to 254 or so expressions
+in a tagbody.
+
+Expressions are converted to closures (fns) in a way that no doubt
+interfers with locals clearing.
+
+## Why?
+
+Maybe I can close the tagbody tab in my browser and stop thinking
+about it now.
+
 ## Me
 - @hiredman@downey.family
 - hiredman on clojurians.slack.com

@@ 14,6 14,8 @@
 that can be jumped to via go in expressions in the dynamic extent of
   the tagbody.
 
+  Executes each expression in sequence. Returns nil.
+
   Limitted to 254 or so expressions. Uses throwables to jump, so if
   you are like me and catch Throwable everywhere, ¯\\_(ツ)_/¯
   

@@ 60,23 60,3 @@
 (deftest common-lisp-hyperspec-example-2
   (is (= 2 (f1 nil)))
   (is (= 1 (f1 true))))
-
-
-
-(with-local-vars
-  [v nil]
-  (tagbody
-   (var-set v 1)
-   (go point-a)
-   (incf v 16)
-   point-c
-   (incf v 4)
-   (go point-b)
-   (incf v 32)
-   point-a
-   (incf v 2)
-   (go point-c)
-   (incf v 64)
-   point-b
-   (incf v 8))
-  (var-get v))