`odoc html-deps`'s interface
Open
Nobody has claimed this yet.
command line
documentation
- Dominant language
- OCaml
- Stars
- 355
- Forks
- 114
- Avg merge
- 6d 21h
- Merged PRs (30d)
- 10
Description
As it stands odoc html-deps takes a "package directory" as a parameter. Since as far as I know odoc files are not namespaced by directories this seems a bit odd.
Is there any reason why odoc html-deps does not act on odoc files ?
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 reviewing the odoc html-deps command interface and how it uses the package directory. Determine whether the command should operate on individual odoc files and what behavior is expected for file inputs. The issue is complete only when the intended interface and scope are decided and implemented or documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ocaml
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100