micahelliott / clojure-docs-peek Goto Github PK

Could display as:

clojure.string/split (public)
...

It's trickier to get this info, but available with something like: (cider-interactive-eval "(:private (meta #'some.ns/some-function))")

This is useful just for local functions.

(:import [java.math RoundingMode]
           [java.util Locale])

RoundingMode/HALF_EVEN

Both of those have interesting docstring that are not being shown.

When a partial docstring or xrefs or other stats are shown, give a hint on how to find more info. Eg:

Number of references: 4 (use `C-c C-? r` to navigate xrefs)

Slightly annoying to have to call the toggle again to close the peek, when all you should need to do is move point.

Could depend on where in symbol point is. Eg, for str/split, if on str do ns popup, if on split do fn popup.

Some docstrings will be too long to be fully displayed. Should only include a paragraph or two.

Could also rely on markdown/formatting sections and only show the first.

It works with corfu on the first completion, keeping the list of completions, but after moving down to other candidates, toggling cdp stops the corfu completion.

Could have a small stats section showing possibly:

• number of functions
• if a test file is missing
• lines of code
• number of uses/references
• number of kondo/flycheck errors or clean
• number of missing docstrings
• what the ns is typically aliased to across project (maybe too broad)