From c0534e08390c3e5e11a4966dccc46c092fa2d6ec Mon Sep 17 00:00:00 2001
From: Mike Thompson <mike.thompson@day8.com.au>
Date: Thu, 20 Jul 2017 18:21:14 +1000
Subject: [PATCH] Improvements is dispatch documentation, ahead of an API
 release

---
 src/re_frame/router.cljc | 21 ++++++++++++++-------
 1 file changed, 14 insertions(+), 7 deletions(-)

diff --git a/src/re_frame/router.cljc b/src/re_frame/router.cljc
index 2595d64..4af3b5c 100644
--- a/src/re_frame/router.cljc
+++ b/src/re_frame/router.cljc
@@ -227,14 +227,16 @@
 ;;
 
 (defn dispatch
-  "Queue the given event for processing by the registered event handler.
+  "Enqueue `event` for processing by event handling machinery.
 
-  Just to be clear: the event handler is not run immediately - it is not run
+  `event` is a vector of length >= 1. The 1st element identifies the kind of event.
+
+  Note: the event handler is not run immediately - it is not run
   synchronously. It will likely be run 'very soon', although it may be
   added to the end of a FIFO queue which already contain events.
 
   Usage:
-     (dispatch [:delete-item 42])"
+     (dispatch [:order-pizza {:supreme 2 :meatlovers 1 :veg 1})"
   [event]
   (if (nil? event)
       (throw (ex-info "re-frame: you called \"dispatch\" without an event vector." {}))
@@ -243,13 +245,18 @@
 
 
 (defn dispatch-sync
-  "Sychronously (immediately!) process the given event using the registered handler.
+  "Synchronously (immediately) process `event`. Do not queue.
 
-  Generally, you shouldn't use this - you should use `dispatch` instead.  It
-  is an error to use `dispatch-sync` within an event handler.
+  Generally, don't use this. Instead use `dispatch`. It is an error
+  to use `dispatch-sync` within an event handler.
+
+  Useful when any delay in processing is a problem:
+     1. the `:on-change` handler of a text field where we are expecting fast typing.
+     2  when initialising your app - see 'main' in todomvc examples
+     3. in a unit test where we don't want the action 'later'
 
   Usage:
-     (dispatch-sync [:delete-item 42])"
+     (dispatch-sync [:sing :falsetto 634])"
   [event-v]
   (handle event-v)
   (-call-post-event-callbacks event-queue event-v)  ;; slightly ugly hack. Run the registered post event callbacks.