canonical paths: check equivalence
Open
Nobody has claimed this yet.
cross-referencer
- Dominant language
- OCaml
- Stars
- 355
- Forks
- 114
- Avg merge
- 6d 21h
- Merged PRs (30d)
- 10
Description
For the moment we allow users to annotate module definitions with (** @canonical Some.Path *) but we do not check that Some.Path is indeed equivalent to the module being defined.
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
No files or tests are named. Start by tracing how @canonical annotations are parsed and resolved in odoc, then identify where the defined module can be compared with Some.Path. Done means an invalid canonical path is detected and an equivalent path is accepted, with coverage for both cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ocaml
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100