ocaml / ocaml/odoc

Treat inherit like include

Open
#753 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement output
Dominant language
OCaml
Stars
355
Forks
114
Avg merge
6d 21h
Merged PRs (30d)
10

Description

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 the example generated page at https://v3.ocaml.org/p/ppxlib/0.23.0/doc/Ppxlib/Ast_traverse/class-fold/index.html and compare how inherit and include are represented. Trace the documentation compiler behavior for both constructs; done means pages using inherit are handled like pages using include.

Written by the indexing model from the issue text.

Assessment

Tech stack
ocaml
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.