From 0f194b64cf2679f06b84825d625faf4f3b5c905b Mon Sep 17 00:00:00 2001 From: gered Date: Tue, 25 Mar 2014 11:29:12 -0400 Subject: [PATCH] update README.md --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a8026eb..60aab71 100644 --- a/README.md +++ b/README.md @@ -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.