From aedafd1ac9513f344a56471b8fa8322f122f2e09 Mon Sep 17 00:00:00 2001
From: "Stephen C. Gilardi" <scgilardi@gmail.com>
Date: Wed, 4 Nov 2015 09:03:01 -0500
Subject: [PATCH] doc string edits

---
 src/re_frame/router.cljs | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/src/re_frame/router.cljs b/src/re_frame/router.cljs
index 9780509..a4873bd 100644
--- a/src/re_frame/router.cljs
+++ b/src/re_frame/router.cljs
@@ -185,11 +185,10 @@
 ;;
 
 (defn dispatch
-  "Send an event to be processed by the registered handler.
+  "Queue an event to be processed by the registered handler.
 
   Usage example:
-     (dispatch [:delete-item 42])
-  "
+     (dispatch [:delete-item 42])"
   [event-v]
   (if (nil? event-v)
     (error "re-frame: \"dispatch\" is ignoring a nil event.")
@@ -198,8 +197,9 @@
 
 
 (defn dispatch-sync
-  "Send an event to be processed by the registered handler, but avoid the async-inducing
-  use of core.async/chan.
+  "Send an event to be processed by the registered handler
+  immediately. Note: dispatch-sync may not be called while another
+  event is being handled.
 
   Usage example:
      (dispatch-sync [:delete-item 42])"