ocaml / ocaml/odoc

Allow dependencies to be specified explicitely rather than through `-I`.

Open
#81 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

command line not stale
Dominant language
OCaml
Stars
355
Forks
114
Avg merge
6d 21h
Merged PRs (30d)
10

Description

For instance in odig I already have the precise info, I prune it into -I and odoc does the lookup again which is absurd.

Note that it may be better to allow to specify them in a file (e.g. one per line) rather than on the cli proper since IIRC some environments have low limits on the number of cli arguments you can specify.

Ideally the scheme would be the same as the one which would be chosen for the compiler (e.g. see this). I guess @lpw25 must have something in mind for that in the context of his namespace proposal.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with odoc's -I dependency lookup and compare it with odig's existing pruned dependency information. Review the linked compiler scheme and namespace proposal before deciding whether explicit dependencies should be passed on the CLI or through a file. Done means odoc can consume explicit dependencies without repeating the lookup and follows the compiler's chosen scheme.

Written by the indexing model from the issue text.

Assessment

Tech stack
ocaml
Domain
compilers, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.