Skip to content

Commit a68761b

Browse files
committed
Add a section on var metadata in the caveats listing
1 parent 8f7f123 commit a68761b

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ CIDER packs plenty of features. Here are some of them (in no particular order):
8080
- [Managing multiple sessions](#managing-multiple-sessions)
8181
- [Requirements](#requirements)
8282
- [Caveats](#caveats)
83+
- [Var Metadata](#var-metadata)
8384
- [ClojureScript limitations](#clojurescript-limitations)
8485
- [Microsoft Windows](#microsoft-windows)
8586
- [powershell.el](#powershell-el)
@@ -941,6 +942,17 @@ change `*cider-repl localhost*` to `*cider-repl foo*`.
941942

942943
## Caveats
943944

945+
### Var Metadata
946+
947+
Currently var metadata about the location of the var's definition within the
948+
source code (file, line & column) is set only when evaluating the entire source
949+
buffer (<kbd>C-c C-k</kbd>). All other interactive code evaluation commands
950+
(e.g. <kbd>C-c C-e</kbd>) don't set this metadata and you won't be able to use
951+
commands like `find-var` on such vars. That's a
952+
[limitation of nREPL](http://dev.clojure.org/jira/browse/NREPL-59), that's
953+
beyond CIDER. If you want to see interactive evaluation working properly in
954+
CIDER you'll have to push for the aforementioned nREPL issue to be resolved.
955+
944956
### ClojureScript limitations
945957

946958
Currently, the following features are not supported for ClojureScript

0 commit comments

Comments
 (0)