From 7fff9c60391ab53dc0674ff1963d2760459ce185 Mon Sep 17 00:00:00 2001 From: Mike Thompson Date: Fri, 29 Jul 2016 14:31:31 +1000 Subject: [PATCH] Improve comments around post-event-callback stuff --- src/re_frame/core.cljc | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/src/re_frame/core.cljc b/src/re_frame/core.cljc index 1b6a18a..c51ffcd 100644 --- a/src/re_frame/core.cljc +++ b/src/re_frame/core.cljc @@ -76,19 +76,19 @@ ;; -- Event Procssing Callbacks (defn add-post-event-callback - "Registers a callback function 'f'. - f will be called after each dispatched event is procecessed - f will be called with two arguments: - - the event's vector. That which was dispatched orignally. - - the further event queue - what is still to be processed. A PersistentQueue. + "Registers a callback function `f` to be called after each event is procecessed + `f` will be called with two arguments: + - `event`: a vector. The event just processed. + - `queue`: a PersistentQueue, possibly empty, of events yet to be processed. - This is useful in advanced cases like: - - you are implementing a complex bootstrap pipeline - - you want to create your own handling infrastructure, with perhaps multiple - handlers for the one event, etc. Hook in here. - - libraries providing 'isomorphic javascript' rendering on Nodejs or Nashorn. + This is useful in advanced cases like: + - you are implementing a complex bootstrap pipeline + - you want to create your own handling infrastructure, with perhaps multiple + handlers for the one event, etc. Hook in here. + - libraries providing 'isomorphic javascript' rendering on Nodejs or Nashorn. - 'id' is typically a keyword. + 'id' is typically a keyword. It is an identifier, supplied initially + at \"add time\", which can be subsequently be used to remove a callback. " ([f] (router/add-post-event-callback re-frame.router/event-queue f f))