Skip to content

Commit ac5274d

Browse files
committed
Add documentation to cider-resolve.el
1 parent 8413fa1 commit ac5274d

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

cider-resolve.el

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,46 @@
1818
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
1919

2020
;;; Commentary:
21+
;;
22+
;; The ns cache is a dict of namespaces stored in the connection buffer. This
23+
;; file offers functions to easily get information about variables from this
24+
;; cache, given the variable's name and the file's namespace.
25+
;;
26+
;; Below is a typical entry on this cache dict. Note that clojure.core symbols
27+
;; are excluded from the refers to save space.
28+
;;
29+
;; "cider.nrepl.middleware.track-state"
30+
;; (dict "aliases"
31+
;; (dict "cljs" "cider.nrepl.middleware.util.cljs"
32+
;; "misc" "cider.nrepl.middleware.util.misc"
33+
;; "set" "clojure.set")
34+
;; "interns" (dict "assoc-state"
35+
;; (dict "arglists"
36+
;; (("response"
37+
;; (dict "as" "msg" "keys"
38+
;; ("session")))))
39+
;; "filter-core"
40+
;; (dict "arglists"
41+
;; (("refers")))
42+
;; "make-transport"
43+
;; (dict "arglists"
44+
;; (((dict "as" "msg" "keys"
45+
;; ("transport")))))
46+
;; "ns-as-map"
47+
;; (dict "arglists"
48+
;; (("ns")))
49+
;; "ns-cache"
50+
;; (dict)
51+
;; "relevant-meta"
52+
;; (dict "arglists"
53+
;; (("var")))
54+
;; "update-vals"
55+
;; (dict "arglists"
56+
;; (("m" "f")))
57+
;; "wrap-tracker"
58+
;; (dict "arglists"
59+
;; (("handler"))))
60+
;; "refers" (dict "set-descriptor!" "#'clojure.tools.nrepl.middleware/set-descriptor!"))
2161

2262
;;; Code:
2363

0 commit comments

Comments
 (0)