cursive
cursive copied to clipboard
Render references in square brackets as links in docstrings
trafficstars
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:
- https://github.com/cursive-ide/cursive/issues/2022
- https://github.com/cursive-ide/cursive/issues/1226