HTML output of ocamldoc is strange

[vicuna]

Original bug ID: 7411
Reporter: kosik
Assigned to: @Octachron
Status: resolved (set by @Octachron on 2017-04-04T15:05:30Z)
Resolution: fixed
Priority: normal
Severity: minor
Version: 4.02.3
Fixed in version: 4.04.1+dev
Category: ocamldoc

Bug description

If I have a file with the following contents:

module IntSet = Set.Make(struct
type t = int
let compare = compare
end)

and I use ocamldoc to generate HTML:

ocamldoc -html main.ml

then the resulting HTML contains some unexpected:

• vertical skip between line
  "module IntSet: Set.Make(sig"
  and line
  "type t = int "
• even bigger vertical skip between line
  "type t = int "
  and line:
  "val compare : 'a -> 'a -> int"

I am (just) guessing that this is not an expected behavior.

File attachments

• Main.IntSet.html

[vicuna]

Comment author: @Octachron

In this case, the html generated by ocamldoc uses a "pre" tag for the module(sig ...end) part and is not careful enough with whitespace, resulting with this anarchic proliferation of whitespaces.

Since the "pre" tag is not that meaningful here, I would argue that simply closing it at the start of the signature would be enough.

[vicuna]

Comment author: @Octachron

I have a potential fix for the problem here: #914.

[vicuna]

Comment author: @Octachron

The above github PR have been integrated into the 4.04.1 release, fixing this issue.