Skip to content

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

Open
@eval-exec

Description

@eval-exec

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

Activity

eval-exec

eval-exec commented on Oct 1, 2024

@eval-exec
Author

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

eval-exec

eval-exec commented on Oct 1, 2024

@eval-exec
Author

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

All clojuredocs's exmaple are there.

yuhan0

yuhan0 commented on Oct 2, 2024

@yuhan0
Contributor

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.

github-actions

github-actions commented on Jan 19, 2025

@github-actions

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!

bbatsov

bbatsov commented on Jan 23, 2025

@bbatsov
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @bbatsov@yuhan0@eval-exec

        Issue actions

          Add examples from https://clojuredocs.org/ to `(cider-doc)`'s result buffer · Issue #3744 · clojure-emacs/cider