gered/clj-metasearch
Archived
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

update README.md

Browse source
This commit is contained in:
Gered 2014-03-25 11:29:12 -04:00
parent 6557f723d0
commit 0f194b64cf
1 changed files with 7 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -30,8 +30,9 @@ Hello world!
```
By default `find-vars` will search all Clojure namespaces it can find in the current classpath. We can filter
which Clojure namespaces are checked by supplying an additional predicate to `find-vars` which will be run
on each namespace (as a symbol) found.
which Clojure namespaces are checked by supplying an additional predicate to `find-vars` under the
`:namespace-pred` argument. This predicate will be run on each namespace found (the namespace will be passed
as a symbol to the predicate).
```clojure
; no namespace filtering. all namespaces are checked
@ -63,6 +64,10 @@ behaviour. Passing `true` will cause each namespace being checked to first be lo
=> ({:ns clojure.xml, :var (var clojure.xml/parse)})
```
When you use `true` for `:require-all-namespaces?`, it would normally be a good idea to supply a namespace
predicate via `:namespace-pred` if at all possible to avoid unnecessarily loading a whole bunch of extra
namespaces.
## License
Distributed under the the MIT License. See LICENSE for more details.