[Documentation] Tip to evaluate namespace before lookup #2926
Conversation
Add Tip to "Working with Documentation" page that a namespace should be evaluated before lookup of documentation. Resolves: #2913
| @@ -11,6 +11,8 @@ press kbd:[C-c C-d C-d] then. This open a documentation buffer | |||
| containing all the relevant information about the thing referenced | |||
| by the symbol (special form, var, Java method, etc). | |||
|
|
|||
| TIP: Ensure the namespace of a var is evaluated before looking up the documentation. Cider relies on the runtime state to lookup documentation. | |||
There was a problem hiding this comment.
This applies to every feature in CIDER, so I'm not sure we need to repeat it everywhere.
There was a problem hiding this comment.
Okay, so you just want to keep this on the one page in the docs. I'll close the pr.
|
For the record - I think it'd be best if we devised some way to warn people when they are trying to do something in an unevaluated ns. That's going to be way more effective way to get the message across. Evals handle this to some extent by auto-evaling the |
|
From the tests I've done this evening, it seems that help is only available for Clojure special forms until any namespace is evaluated. Getting help for The biggest pain point I've experienced is receiving the I've updated my own documentation to cover this in detail, as I didnt find this information in the official docs. |
Special forms are not resolved, they are pretty much hardcoded, that's why they work everywhere.
You mean you get it after the resolution fails, right? |
Add Tip to "Working with Documentation" page that a namespace should be
evaluated before lookup of documentation.
Resolves: #2913
Before submitting the PR make sure the following things have been done (and denote this
by checking the relevant checkboxes):
eldev test)eldev lint) - no lint errors on specific change