Original bug ID: 7352 Reporter:@dbuenzli Assigned to:@Octachron Status: resolved (set by @Octachron on 2017-03-15T22:08:39Z) Resolution: fixed Priority: normal Severity: minor Version: 4.03.0 Target version: 4.05.0 +dev/beta1/beta2/beta3/rc1 Fixed in version: 4.06.0 +dev/beta1/beta2/rc1 Category: ocamldoc Monitored by:@gasche@dbuenzli
Bug description
They sometimes introduce unwanted whitespace in the rendered output and makes it difficult to design a consistent stylesheet (you randomly get either too much whitespace or too little). Using a p:empty rule to hide them is impossible since they do actually have content in it.
Note that in general ocamldoc is really a bit too fiddly with whitespace. It should really follow the simple rules that are present in most ASCII markup languages, which is basically to always generate blocks, those being either separated syntactically by one of its markup language level block or by a blank line.
So for example all the following examples should really only generate a p followed by a pre followed by a p and nothing else.
Original bug ID: 7352
Reporter: @dbuenzli
Assigned to: @Octachron
Status: resolved (set by @Octachron on 2017-03-15T22:08:39Z)
Resolution: fixed
Priority: normal
Severity: minor
Version: 4.03.0
Target version: 4.05.0 +dev/beta1/beta2/beta3/rc1
Fixed in version: 4.06.0 +dev/beta1/beta2/rc1
Category: ocamldoc
Monitored by: @gasche @dbuenzli
Bug description
They sometimes introduce unwanted whitespace in the rendered output and makes it difficult to design a consistent stylesheet (you randomly get either too much whitespace or too little). Using a p:empty rule to hide them is impossible since they do actually have content in it.
Here are a few examples of this.
Before this h2:
http://erratique.ch/tmp/opkg-ocamldoc/var/cache/opkg/ocamldoc/astring/Astring.html#porttrim
Source:
https://github.com/dbuenzli/astring/blob/master/src/astring.mli#L1225
Before this h1:
http://erratique.ch/tmp/opkg-ocamldoc/var/cache/opkg/ocamldoc/astring/Astring.html#port
Source:
https://github.com/dbuenzli/astring/blob/master/src/astring.mli#L1198
Before and after this h1:
http://erratique.ch/tmp/opkg-ocamldoc/var/cache/opkg/ocamldoc/react/React.html#basics
Source:
https://github.com/dbuenzli/react/blob/master/src/react.mli#L821
It seems that it's before header introductions but I wouldn't swear I didn't see this in other places.
The text was updated successfully, but these errors were encountered: