luciano/specter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

improve doc for srange-dynamic

Browse source
This commit is contained in:
nathanmarz 2017-06-07 17:17:13 -04:00
parent 3e4730b44f
commit 7523e43823
1 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
src/clj/com/rpl/specter.cljc
View file

@ -710,16 +710,17 @@
(n/PosNavigator n/get-first n/update-first)) (n/PosNavigator n/get-first n/update-first))
(defnav (defnav
^{:doc "Uses start-fn and end-fn to determine the bounds of the subsequence ^{:doc "Uses start-index-fn and end-index-fn to determine the bounds of the subsequence
to select when navigating. Each function takes in the structure as input."} to select when navigating. `start-index-fn` takes in the structure as input. `end-index-fn`
can be one of two forms. If a regular function (e.g. defined with `fn`), it takes in only the structure as input. If a function defined using special `end-fn` macro, it takes in the structure and the result of `start-index-fn`."}
srange-dynamic srange-dynamic
[start-fn end-fn] [start-index-fn end-index-fn]
(select* [this structure next-fn] (select* [this structure next-fn]
(let [s (start-fn structure)] (let [s (start-index-fn structure)]
(n/srange-select structure s (n/invoke-end-fn end-fn structure s) next-fn))) (n/srange-select structure s (n/invoke-end-fn end-index-fn structure s) next-fn)))
(transform* [this structure next-fn] (transform* [this structure next-fn]
(let [s (start-fn structure)] (let [s (start-index-fn structure)]
(n/srange-transform structure s (n/invoke-end-fn end-fn structure s) next-fn)))) (n/srange-transform structure s (n/invoke-end-fn end-index-fn structure s) next-fn))))
(defnav (defnav