Feature request: pragma to open a module in mld files
Nobody has claimed this yet.
- Dominant language
- OCaml
- Stars
- 355
- Forks
- 114
- Avg merge
- 6d 21h
- Merged PRs (30d)
- 10
Description
Following the discussion of https://github.com/ocaml/dune/issues/5770, it seems we should invent some pragma directive in (the header of?) an mld file that has the same effect of passing the --open option to odoc. This is to make sure that odig and other tools can compile installed mld files with the intended --open options. This feature would also solve https://github.com/ocaml/odoc/issues/805.
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 reading the discussion in ocaml/dune#5770 and the related odoc#805 issue to understand the intended pragma behavior. Then trace how mld files and the --open option are handled. Done means an agreed pragma syntax lets odig and other tools compile installed mld files with the intended opened modules.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ocaml
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100