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

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

Open
eval-exec opened this issue Oct 1, 2024 · 5 comments
Open
Labels
enhancement good first issue A simple tasks suitable for first-time contributors stale

Comments

@eval-exec
Copy link

eval-exec commented Oct 1, 2024

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
Copy link
Author

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

@eval-exec
Copy link
Author

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

All clojuredocs's exmaple are there.

@yuhan0
Copy link
Contributor

yuhan0 commented Oct 2, 2024

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.

Copy link

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 github-actions bot added the stale label Jan 19, 2025
@bbatsov
Copy link
Member

bbatsov commented Jan 23, 2025

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

@bbatsov bbatsov added enhancement good first issue A simple tasks suitable for first-time contributors labels Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement good first issue A simple tasks suitable for first-time contributors stale
Projects
None yet
Development

No branches or pull requests

3 participants