Add table of contents and path. Need path example.

This commit is contained in:
Chris O'Donnell 2016-06-15 09:37:23 -04:00
parent 81e439e8fd
commit ee095a7fe0

View file

@ -1,5 +1,39 @@
# List of Macros with Examples # List of Macros with Examples
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-generate-toc again -->
**Table of Contents**
- [List of Macros with Examples](#list-of-macros-with-examples)
- [Core Macros](#core-macros)
- [replace-in](#replace-in)
- [select](#select)
- [select-first](#select-first)
- [select-one](#select-one)
- [select-one!](#select-one)
- [setval](#setval)
- [transform](#transform)
- [Path Macros](#path-macros)
- [declarepath](#declarepath)
- [defpathedfn](#defpathedfn)
- [defprotocolpath](#defprotocolpath)
- [extend-protocolpath](#extend-protocolpath)
- [fixed-pathed-nav](#fixed-pathed-nav)
- [path](#path)
- [providepath](#providepath)
- [variable-pathed-nav](#variable-pathed-nav)
- [Collector Macros](#collector-macros)
- [defcollector](#defcollector)
- [paramscollector](#paramscollector)
- [pathed-collector](#pathed-collector)
- [Navigator Macros](#navigator-macros)
- [defnav](#defnav)
- [defnavconstructor](#defnavconstructor)
- [nav](#nav)
- [paramsfn](#paramsfn)
<!-- markdown-toc end -->
## Core Macros ## Core Macros
### replace-in ### replace-in
@ -259,6 +293,18 @@ are required, then the result is executable.
See [defpathedfn](#defpathedfn) for an example. See [defpathedfn](#defpathedfn) for an example.
### path
`(path & path)`
Same as calling comp-paths, except it caches the composition of the static part
of the path for later re-use (when possible). For almost all idiomatic uses
of Specter provides huge speedup. This macro is automatically used by the
select/transform/setval/replace-in/etc. macros.
```clojure
```
### providepath ### providepath
`(providepath name apath)` `(providepath name apath)`