From 28ecb90489992e3fe1b4be4f7c3dc5ea406a6cd5 Mon Sep 17 00:00:00 2001 From: nathanmarz Date: Sun, 12 Feb 2017 11:38:45 -0500 Subject: [PATCH] add docstrings --- src/clj/com/rpl/specter.cljc | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/clj/com/rpl/specter.cljc b/src/clj/com/rpl/specter.cljc index 308e873..b37849a 100644 --- a/src/clj/com/rpl/specter.cljc +++ b/src/clj/com/rpl/specter.cljc @@ -517,9 +517,13 @@ [apath structure] (compiled-traverse (i/comp-paths* apath) structure)) -(def compiled-traverse-all i/compiled-traverse-all*) +(def ^{:doc "Version of traverse-all that takes in a path precompiled with comp-paths"} + compiled-traverse-all i/compiled-traverse-all*) -(defn traverse-all* [apath] (compiled-traverse-all (i/comp-paths* apath))) +(defn traverse-all* + "Returns a transducer that traverses over each element with the given path." + [apath] + (compiled-traverse-all (i/comp-paths* apath))) ;; Transformation functions