The `{!modules}` directive should splice in the module synopsis

[dbuenzli]

These kind of lists are a bit bland and not very user friendly. Having the module synopsis next to the name would be nice.

Also it would be nice to classify the generated ul a bit along the way so that it can be easily styled.

[rizo]

it would be nice to classify the generated ul

What would be an appropriate class for the ul? Would class="modules" be ok?

[dbuenzli]

That's what they used to be yes.

[rizo]

Having the module synopsis next to the name would be nice.

Do you have a preference on the markup for this? I looked at the output from ocamldoc and it seems to generate a table.

[dbuenzli]

Tables are nice to align things if you know how long these things will be. Since in general we don't know how long module identifiers are going to be I'd rather not do this other wise you may get

M                      M's synopsis
M_with_a_very_long_id  That synopsis

which is difficult to scan.

A good workaround which I once found in a typographic book is to align as follows:

                    M M's synopsis
M_with_a_very_long_id That synopsis

but it doesn't look good or natural in all context. Personally I'm fine with:

M M's synopsis
M_with_a_very_long_id That synopsis

so there's no need for tables. However it's always good to properly classify with spans. spaning the synopsis with a synopsis class won't hurt.

[dbuenzli]

Also adding an anchor would be nice.

[greedy]

Wouldn't definition lists like

<dl>
  <dt>M</dt>
  <dd>M's synopsis</dd>
  ...
</dl>

be appropriate for this?

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. The main purpose of this is to keep the issue tracker focused to what is actively being worked on, so that the amount and variety of open yet inactive issues does not overwhelm contributors.

An issue closed as stale is not rejected — further discussion is welcome in its closed state, and it can be resurrected at any time. odoc maintainers regularly check issues that were closed as stale in the past, to see if the time is right to reopen and work on them again. PRs addressing issues closed as stale are as welcome as PRs for open issues. They will be given the same review attention, and any other help.