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

fix typos in docstrings

Browse source
This commit is contained in:
Nathan Marz 2016-06-09 23:19:03 -04:00
parent 0c4c4369a2
commit 3af11575d7
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
src/clj/com/rpl/specter/macros.clj
View file

@ -536,7 +536,7 @@
(defmacro select (defmacro select
"Navigates to and returns a sequence of all the elements specified by the path. "Navigates to and returns a sequence of all the elements specified by the path.
This macro will attempt to do inline factoring and caching of the path, falling This macro will attempt to do inline factoring and caching of the path, falling
back to compiling the path on every invocation it it's not possible to back to compiling the path on every invocation if it's not possible to
factor/cache the path." factor/cache the path."
[apath structure] [apath structure]
`(i/compiled-select* (path ~apath) ~structure)) `(i/compiled-select* (path ~apath) ~structure))
@ -544,7 +544,7 @@
(defmacro select-one! (defmacro select-one!
"Returns exactly one element, throws exception if zero or multiple elements found. "Returns exactly one element, throws exception if zero or multiple elements found.
This macro will attempt to do inline factoring and caching of the path, falling This macro will attempt to do inline factoring and caching of the path, falling
back to compiling the path on every invocation it it's not possible to back to compiling the path on every invocation if it's not possible to
factor/cache the path." factor/cache the path."
[apath structure] [apath structure]
`(i/compiled-select-one!* (path ~apath) ~structure)) `(i/compiled-select-one!* (path ~apath) ~structure))
@ -552,7 +552,7 @@
(defmacro select-one (defmacro select-one
"Like select, but returns either one element or nil. Throws exception if multiple elements found. "Like select, but returns either one element or nil. Throws exception if multiple elements found.
This macro will attempt to do inline factoring and caching of the path, falling This macro will attempt to do inline factoring and caching of the path, falling
back to compiling the path on every invocation it it's not possible to back to compiling the path on every invocation if it's not possible to
factor/cache the path." factor/cache the path."
[apath structure] [apath structure]
`(i/compiled-select-one* (path ~apath) ~structure)) `(i/compiled-select-one* (path ~apath) ~structure))
@ -560,7 +560,7 @@
(defmacro select-first (defmacro select-first
"Returns first element found. "Returns first element found.
This macro will attempt to do inline factoring and caching of the path, falling This macro will attempt to do inline factoring and caching of the path, falling
back to compiling the path on every invocation it it's not possible to back to compiling the path on every invocation if it's not possible to
factor/cache the path." factor/cache the path."
[apath structure] [apath structure]
`(i/compiled-select-first* (path ~apath) ~structure)) `(i/compiled-select-first* (path ~apath) ~structure))
@ -569,7 +569,7 @@
"Returns any element found or [[NONE]] if nothing selected. This is the most "Returns any element found or [[NONE]] if nothing selected. This is the most
efficient of the various selection operations. efficient of the various selection operations.
This macro will attempt to do inline factoring and caching of the path, falling This macro will attempt to do inline factoring and caching of the path, falling
back to compiling the path on every invocation it it's not possible to back to compiling the path on every invocation if it's not possible to
factor/cache the path." factor/cache the path."
[apath structure] [apath structure]
`(i/compiled-select-any* (path ~apath) ~structure)) `(i/compiled-select-any* (path ~apath) ~structure))
@ -577,7 +577,7 @@
(defmacro selected-any? (defmacro selected-any?
"Returns true if any element was selected, false otherwise. "Returns true if any element was selected, false otherwise.
This macro will attempt to do inline factoring and caching of the path, falling This macro will attempt to do inline factoring and caching of the path, falling
back to compiling the path on every invocation it it's not possible to back to compiling the path on every invocation if it's not possible to
factor/cache the path." factor/cache the path."
[apath structure] [apath structure]
`(i/compiled-selected-any?* (path ~apath) ~structure)) `(i/compiled-selected-any?* (path ~apath) ~structure))
@ -586,7 +586,7 @@
"Navigates to each value specified by the path and replaces it by the result of running "Navigates to each value specified by the path and replaces it by the result of running
the transform-fn on it. the transform-fn on it.
This macro will attempt to do inline factoring and caching of the path, falling This macro will attempt to do inline factoring and caching of the path, falling
back to compiling the path on every invocation it it's not possible to back to compiling the path on every invocation if it's not possible to
factor/cache the path." factor/cache the path."
[apath transform-fn structure] [apath transform-fn structure]
`(i/compiled-transform* (path ~apath) ~transform-fn ~structure)) `(i/compiled-transform* (path ~apath) ~transform-fn ~structure))
@ -594,7 +594,7 @@
(defmacro setval (defmacro setval
"Navigates to each value specified by the path and replaces it by `aval`. "Navigates to each value specified by the path and replaces it by `aval`.
This macro will attempt to do inline factoring and caching of the path, falling This macro will attempt to do inline factoring and caching of the path, falling
back to compiling the path on every invocation it it's not possible to back to compiling the path on every invocation if it's not possible to
factor/cache the path." factor/cache the path."
[apath aval structure] [apath aval structure]
`(i/compiled-setval* (path ~apath) ~aval ~structure)) `(i/compiled-setval* (path ~apath) ~aval ~structure))
@ -606,7 +606,7 @@
in the final return. replace-in is useful for situations where you need to know the specific values in the final return. replace-in is useful for situations where you need to know the specific values
of what was transformed in the data structure. of what was transformed in the data structure.
This macro will attempt to do inline factoring and caching of the path, falling This macro will attempt to do inline factoring and caching of the path, falling
back to compiling the path on every invocation it it's not possible to back to compiling the path on every invocation if it's not possible to
factor/cache the path." factor/cache the path."
[apath transform-fn structure & args] [apath transform-fn structure & args]
`(i/compiled-replace-in* (path ~apath) ~transform-fn ~structure ~@args)) `(i/compiled-replace-in* (path ~apath) ~transform-fn ~structure ~@args))