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

better doc for by-key

Browse source
This commit is contained in:
Christophe Grand 2015-09-03 12:54:47 +02:00
parent 85894738ab
commit 371add5fcb
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
src/net/cgrand/xforms.clj
View file

@ -63,8 +63,11 @@
(defn- noprf "The noop reducing function" ([acc] acc) ([acc _] acc))
(defn by-key
"Returns a tranducer that applies the transducer xform independently for items partitioned by kfn.
(This docstring is a hard nut to crack.)"
"Returns a transducer which partitions items according to kfn.
It applies the transform specified by xform to each partition.
Partitions contain the \"value part\" (as returned by vfn) of each item.
The resulting transformed items are wrapped back into a \"pair\" using the pair function.
Default values for kfn, vfn and pair are first, second and vector."
([xform] (by-key key' val' vector xform))
([kfn xform] (by-key kfn identity vector xform))
([kfn vfn xform] (by-key kfn vfn vector xform))