Dev meeting 2021 03 25

Odoc dev meeting 2021-03-25

Attendees

@jonludlam @lortex @lubega-simon @julow @lpw25 @Drup

2.0 issues

New:

• Memory issues noticed in JS. Issue to be created.

• Strengthening in the presence of Module Type Of - possibly down to strengthening with a hidden module. Issue to be created.

• #650 (Need ModuleType 'aliases') - suggestion: 2.0.0 (otherwise would break links)

• #648 (Warnings about ambigous references are bogus) - suggestion: 2.0.0, with 'check' issue

• #645 (Comment attached to include are dropped) - PR in progress

  • always drop the top comment in the signature expansion
  • take the top-comment in @inline includes that are the first item of a sig

• #636 (Renderers: allow for unqualified identifier rendering) suggestion: post 2.0.0

• #651 ( Improve tests for generators (html, man, and latex))

Fixed since last time:

• #590 (Enable references to refer to pages with '.' or '-')

• #541 (Alignment "styles" (Center, Left, Right) are not supported) - @lubegasimon

• #328 (No code change)

• #631 - PR #640, also fixes #235

PRs open:

• issue #632 (No synopsis rendered for modules) - PR #643. Some discussion happened - good to merge now?

• #644 - documentation of how to write comments in modules

• issue #559 (Canonical does not work on compilation units) - PR #649

In progress:

• #460 (reference driver needed) - in progress, on hold

• #573 (docs are bad) - in progress, on hold

• #557 (Command to extract errors from odocl files) - @jonludlam to fix

• #478 (Top-level doc-comments of module types are discarded) - @Julow - is this now fixed?

Unstarted:

Just the new issues

docs.ocaml.org

@lortex working hard on this - excellent progress! (demo??)

https://ci.mirage.io/wip/packages/index.html

Next meeting

• 2021-04-08