From e4ee703a09a36402e02d08e270c66b812f15fd7b Mon Sep 17 00:00:00 2001 From: Nathan Marz Date: Thu, 16 Jun 2016 09:44:30 -0400 Subject: [PATCH] update richnav comment --- src/clj/com/rpl/specter/macros.clj | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/clj/com/rpl/specter/macros.clj b/src/clj/com/rpl/specter/macros.clj index 6f6ea0a..65d7bdd 100644 --- a/src/clj/com/rpl/specter/macros.clj +++ b/src/clj/com/rpl/specter/macros.clj @@ -127,7 +127,9 @@ (defmacro richnav "Defines a navigator with full access to collected vals, the parameters array, and the parameters array index. `next-fn` expects to receive the params array, - the next params index, the collected vals, and finally the next structure. + a params index, the collected vals, and finally the next structure. + `next-fn` will automatically skip ahead in params array by `num-params`, so the + index passed to it is ignored. This is the lowest level way of making navigators." [num-params impl1 impl2] (let [[[s-params & s-body] [t-params & t-body]] (determine-params-impls impl1 impl2)