rescript-lang / rescript-lang/rescript-vscode
Would be nice to post process the doc block for links
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- ReScript
- Stars
- 354
- Forks
- 63
- Avg merge
- 11h 29m
- Merged PRs (30d)
- 1
Description
Low pri.
For a doc block such as:
@ocaml.doc("
The top level provides some generic sort related utilities.
It also has two specialized inner modules
[`Belt.SortArray.Int`](...) and [`Belt.SortArray.String`](...)
")
it'd be nice to postprocess those links so that they're clickable. The IDE supports that. Caveat: doesn't support jumping to a line, so most of the links will be useless for now.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the example @ocaml.doc block and trace how documentation text and its links are handled in the VSCode plugin. Compare the desired clickable links with the IDE behavior described in the issue, then verify that supported links become clickable without implying line navigation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- vscode
- Domain
- developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100