References to variant cases: do not splice the type name in.
Open
Nobody has claimed this yet.
bug
cross-referencer
output
- Dominant language
- OCaml
- Stars
- 355
- Forks
- 114
- Avg merge
- 6d 21h
- Merged PRs (30d)
- 10
Description
If I have :
module Bla : sig
type ha = Alpha | Beta
end
Use {!Bla.Alpha} to say alpha.
The latter line gets rendered as:
Use Bla.ha.Alpha to say alpha.
This should simply be Bla.Alpha, I don't think odoc should invent OCaml syntax that doesn't exist.
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 by reproducing the OCaml module and {!Bla.Alpha} reference shown in the issue, then trace how odoc renders variant-case references. Done means the reference renders as Bla.Alpha rather than Bla.ha.Alpha.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ocaml
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100