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

Add docstrings for keypath, must, and nthpath

Browse source
This commit is contained in:
nathanmarz 2017-02-14 10:46:02 -05:00
parent 16310d6008
commit 71ed0ffae9
1 changed files with 14 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -794,10 +794,21 @@
next-val))
structure)))))
(def keypath (eachnav n/keypath*))
(def must (eachnav n/must*))
(def nthpath (eachnav n/nthpath*))
(def ^{:doc "Navigate to the specified keys one after another. If navigate to NONE,
that element is removed from the map or vector."}
keypath
(eachnav n/keypath*))
(def ^{:doc "Navigate to the specified keys one after another, only if they exist
in the data structure. If navigate to NONE, that element is removed
from the map or vector."}
must
(eachnav n/must*))
(def ^{:doc "Navigate to the specified indices one after another.If navigate to
NONE, that element is removed from the sequence."}
nthpath
(eachnav n/nthpath*))
(defrichnav
^{:doc "Navigates to result of running `afn` on the currently navigated value."}