aboutsummaryrefslogtreecommitdiff
path: root/src/clojure
diff options
context:
space:
mode:
authorStuart Sierra <mail@stuartsierra.com>2009-08-19 12:35:54 -0400
committerStuart Sierra <mail@stuartsierra.com>2009-08-19 12:35:54 -0400
commitbb633a1ccd99c0dc7bede9fb4268649e254b5702 (patch)
tree429f7dd2ea1cdaf37d9061448264f8eb1b46c36d /src/clojure
parent35fa51c46e772eec302521eef1382798eb4290b1 (diff)
str_utils2.clj: modified doc string for escape
Diffstat (limited to 'src/clojure')
-rw-r--r--src/clojure/contrib/str_utils2.clj5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/clojure/contrib/str_utils2.clj b/src/clojure/contrib/str_utils2.clj
index 33ed857c..8efbfd0a 100644
--- a/src/clojure/contrib/str_utils2.clj
+++ b/src/clojure/contrib/str_utils2.clj
@@ -88,8 +88,9 @@
(lazy-seq (f s 0))))
(defn escape
- "Escapes characters in string according to a cmap, a function or map
- from characters to their replacements."
+ "Returns a new String by applying cmap (a function or a map) to each
+ character in s. If cmap returns nil, the original character is
+ added to the output unchanged."
[#^String s cmap]
(let [buffer (StringBuilder. (.length s))]
(dochars [c s]