Skip to content

Dev meeting 2020 10 15

Jon Ludlam edited this page Oct 15, 2020 · 2 revisions

Agenda

Attending

  • @jonludlam
  • @trefis
  • @octachron
  • @Drup
  • @lubegasimon
  • @Julow

Previous actions

  • @jonludlam to find out status of dune build @doc supporting external libs -- Not done

  • @jonludlam to post on discuss about plans for replacing ocamldoc plugins -- Not done

  • @jonludlam to ask @dbuenzli whether odig uses odoc html-fragment It does: it's used to for the --index-intro argument. Should be made redundant with the new parent-child work. Hence, no urgency to fix the code, it'll be GC'd soon.

Status report

  • Lots of PRs merged since last time
  • Work begun on parent/child work
  • Scopes need attention

This is the question of what compilation_units/pages will be in scope, and can be referred do unqualified in a reference. Currently we say that all modules in every package appearing in your dependencies (direct and indirect) are in scope and may be referred to. The plan to be able to refer to other packages via a package-foo.bar syntax is now trickier as 'package' as a concept has been removed from odoc.

@trefis and @jonludlam to have a discussion about this soon.

CI

New tests

  • New code to dump odoc/odocl files as json.
  • To be used for test/debug mainly.
  • Tests can be made for model directly rather than via html output
  • Example in PR - https://github.com/ocaml/odoc/pull/502
  • Using dune's new cram testing (mdx test support in dune a bit lacking)

Travis / ocaml-ci

  • Travis very slow, but still had macOS / esy tests that ocaml-ci doesn't
  • ocaml-ci lightning quick
  • suggestion: Move as many tests as possible to ocaml-ci. What do we do with Travis? Is github actions a better solution? @trefis: we moved merlin to github actions and it was very fast. @Ulysse did the work so @Julow might be well placed to talk about it?

Latex backend PRs

  • Do the test one first, then the other is to be rebased.

Extraction of comment parser library

Let's extract out octavius into a separate library again. everyone: It's a good plan, let's do it!

Next meeting

Thursday 29th 1pm BST