Skip to content

Conversation

@Drup
Copy link
Contributor

@Drup Drup commented May 9, 2021

This implements #614 : It uses lists instead of tables to layout datatypes, and add some heuristics to simplify the layout when the documentation payload is a single paragraph.

In practice, the layout for a sum datatype with a single-paragraph comment now looks like this:

<ol>
  <li id="type-variant.TagA" class="anchored">
    <a href="#type-variant.TagA" class="anchor"></a>
    <code><span>| </span><span><span class="constructor">TagA</span></span></code>
    <span class="def-doc">
      <span class="comment-delim">(*</span>This comment is for <code>TagA</code>.<span class="comment-delim">*)</span>
    </span>
  </li>
  ......
</ol>

The span def-doc is changed for a div for longer documentation comments.
The CSS has not been adapted yet (cue @dbuenzli !).

@jonludlam
Copy link
Member

we're waiting on the CSS for this, right?

@leviroth
Copy link

With the merge of #830, can this be closed?

@panglesd
Copy link
Collaborator

Yes!

@panglesd panglesd closed this Mar 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants