Contributing

Building and testing

odoc-parser uses dune to build and run tests. We use inline expect tests with ppx_expect - see the test file .

We require that the parser builds and tests pass on all versions of the OCaml compiler from 4.02.3 onwards. This is tested on each pull request by ocaml-ci.

Build the project using

$ dune build

and test using

$ dune runtest

if the code has changed and the tests require updating, use dune promote.