Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Weird newline in rendering of tags #1136

Open
dlesbre opened this issue May 26, 2024 · 0 comments
Open

Weird newline in rendering of tags #1136

dlesbre opened this issue May 26, 2024 · 0 comments

Comments

@dlesbre
Copy link

dlesbre commented May 26, 2024

The @raise tag is described as @raise Error text which seems intuitive enough, but the HTML render puts the text in a separate paragraph:

  raise Error

  text

This looks weird and can often break the flow of text (I tend to write @raise Exn if bla bla bla, which looks fine in the mli but weird in the docs since the paragraph break also breaks a sentence in two).

This also happens with the @param tag (I haven't checked for any others).

This can be fixed by the following CSS:

li.raises>p:first-of-type {
  display: inline;
}

However, a cleaner fix would involve not generating this first <p> block, or moving the <span>raises<\span> <a>Exn<\a> inside the first <p>.

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

No branches or pull requests

1 participant