'fulcro-reitit: Add docstring for will-enter helper'

dvingo · Feb 21, 2022 · 31c18a1 · 31c18a1
1 parent 6097998
commit 31c18a1
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/main/dv/fulcro_reitit.cljs b/src/main/dv/fulcro_reitit.cljs
@@ -554,6 +554,8 @@
 
 ;{:malli/schema [:=> [:cat ]]}
 (defn will-enter
+  "Takes a will-enter function as expected for use in fulcro routing, but replaces any parameters in the second argument
+  with their coerced values from the current route match if those parameters are present."
   [f]
   (fn will-enter [app args]
     (let [current-route (current-route-from-url app)