Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement cider-doc for keywords #818

Closed
vemv opened this issue Sep 25, 2023 · 1 comment
Closed

Implement cider-doc for keywords #818

vemv opened this issue Sep 25, 2023 · 1 comment
Assignees

Comments

@vemv
Copy link
Member

vemv commented Sep 25, 2023

Context

Compliment and Corfu can reach for cider-doc for describing a candidate.

When that candidate is a keyword, nothing is shown (because cider-doc isn't implemented for keywords), which depending on the Compliment setup, can result in this ugly buffer being shown:

image

Task

Implement, for now, a bare-bones code path for cider-doc such that we'll at least show the 'arities' that all keywords share ([map], [map not-found]).

If it's at hand, we can also show the spec, if found.

We can leave as a TODO showing the xrefs.

@vemv vemv self-assigned this Sep 25, 2023
@vemv
Copy link
Member Author

vemv commented Oct 8, 2023

This isn't as important, following come Company commits (which will no longer show useless doc buffer)

(also, I had meant to open this under https://github.com/clojure-emacs/cider/issues - not cider-nrepl)

@vemv vemv closed this as completed Oct 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant