Fix: Do not call cider-docstring fns unless we have a doc #3764
Conversation
Sometimes, there is no "doc" attribute in the nrepl-dict. In such cases, `fetched-doc` is nil, which causes `cider-docstring--*` functions to error. We should only call these functions when we have a docstring to render. Fixes: clojure-emacs#3763
| (if compact | ||
| (cider-docstring--trim | ||
| (cider-docstring--format fetched-doc)) | ||
| fetched-doc)) | ||
| (unless compact |
There was a problem hiding this comment.
Btw, this unless looks weird to me. Shouldn't this also check fetched-doc?
There was a problem hiding this comment.
My understanding of the code is:
- Return
rendered-fragmentsif we already have them - Else return the
fetched-doc(handle optionalcompactflag, depending on where the doc is being rendered) - Else return "Not documented" for when we are rendering in Help buffer, or return nothing if rendering an e.g. completion popup.
Only code-path 2 deals with fetched-doc. Others don't.
There was a problem hiding this comment.
This part I get - I'm just confused how can a check about compact be related to the presence or absence of a docstring. I know it's not directly related to your PR - it's just something that looks wrong to me, so I thought I should mention it.
There was a problem hiding this comment.
If the caller is asking for a compact docstring, and no docstring exists, return nil. If the caller is asking for an "expanded" docstring, and no docstring exists, return "not documented".
There was a problem hiding this comment.
Yeah, yeah - I get this part. I was just wondering why "not documented" is not a good option in both cases. Anyways, not a big deal.
|
Just add a changelog for your bigfix and we're good go. |
Sometimes, there is no "doc" attribute in the nrepl-dict. In such cases,
fetched-docis nil, which causescider-docstring--*functions to error.We should only call these functions when we have a docstring to render.
Fixes: #3763
Replace this placeholder text with a summary of the changes in your PR.
The more detailed you are, the better.
Before submitting the PR make sure the following things have been done (and denote this
by checking the relevant checkboxes):
eldev test)eldev lint) which is based onelisp-lintand includescheckdoc, check-declare, packaging metadata, indentation, and trailing whitespace checks.Thanks!