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

Render references in square brackets as links in docstrings #2949

Open
devurandom opened this issue Aug 20, 2024 · 0 comments
Open

Render references in square brackets as links in docstrings #2949

devurandom opened this issue Aug 20, 2024 · 0 comments

Comments

@devurandom
Copy link

The Clojure Style Guide suggests:

Wrap any var references in the docstring with ` so that tooling can identify them. Wrap them with [[..]] if you want to link to them.

(defn wombat
  "Acts much like `clojure.core/identity` except when it doesn't.
  Takes `x` as an argument and returns that. If it feels like it.
  See also [[kangaroo]]."
  [x]
  ...)

(https://guide.clojure.style/#document-references)

It would be nice if Cursive would display such references in [[symbol]] square brackets similar to how it displays symbol in a code context: with help / docstring on hover and the ability to jump to it with ctrl+click.

Maybe this is easier than complete markdown formatting, since the syntax and expected semantics are more explicit?

Related:

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