cider icon indicating copy to clipboard operation
cider copied to clipboard

Add examples from https://clojuredocs.org/ to `(cider-doc)`'s result buffer

Open eval-exec opened this issue 1 year ago • 5 comments

Is your feature request related to a problem? Please describe. I'm leaning clojure language now, and I like to learn clojure function's usage from https://clojuredocs.org, for example, when I put cursor in format, then I hit K(cider-doc), it will show: image But I think it would be more convinent if cider-doc can show examples from about https://clojuredocs.org/clojure.core/format image

(As clojure beginners, examples are very helpful for us)

Describe the solution you'd like

let cider download all examples from https://clojuredocs.org, and display examples under (cider-doc)'s result buffer

Describe alternatives you've considered None Additional context None

eval-exec avatar Oct 01 '24 04:10 eval-exec

Hello, cider's developers, do you think this is a good idea?

eval-exec avatar Oct 01 '24 04:10 eval-exec

I found this repo: https://github.com/clojure-emacs/clojuredocs-export-edn

All clojuredocs's exmaple are there.

eval-exec avatar Oct 01 '24 05:10 eval-exec

Are you aware of the command M-x cider-clojuredocs (C-c C-d C-c)?

Perhaps it would help discoverability to introduce a [View Clojuredocs] button in the *cider-doc* buffer when applicable, somewhere close to the existing "Also See" buttons.

yuhan0 avatar Oct 02 '24 12:10 yuhan0

This issue has been automatically marked as stale because it has not had any recent activity. It will be closed soon if no further activity occurs. Thank you for your contribution and understanding!

github-actions[bot] avatar Jan 19 '25 02:01 github-actions[bot]

Yeah, I think a simple extra button will be enough.

bbatsov avatar Jan 23 '25 06:01 bbatsov