Doc comments don't appear in IDE
Open
Nobody has claimed this yet.
Editor support
- Dominant language
- OCaml
- Stars
- 10.3k
- Forks
- 438
- PR merge metrics
- No merged PRs in 30d
Description
When I add a doc comment to a ReasonML value that comment doesn't appear in my IDE, whereas it does for OCaml files.
OCaml file (.ml) ✅
It shows the doc comment as well as the type
ReasonML file (.re) ❌
It only shows the type of the value, not the doc comment
Contributor guide
No contributing guide indexed for this repository
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
The report names no files, tests, or entry points. Start by reproducing the difference between doc comments in .ml and .re files, then trace the IDE information path; done means the ReasonML value shows its doc comment alongside its type.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ocaml
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100