[Haddock] [haddock] #241: Ugly definition lists

haddock haddock at projects.haskell.org
Sat Mar 2 22:03:51 GMT 2013


#241: Ugly definition lists
-------------------+--------------------------------------------------------
Reporter:  duairc  |       Owner:     
    Type:  defect  |      Status:  new
Priority:  major   |   Milestone:     
 Version:  2.13.1  |    Keywords:     
-------------------+--------------------------------------------------------
 The HTML produced by definition lists in the comments of class methods is
 currently displayed rather uglily when styled by ocean.css. For example,
 the HTML page produced by haddock for following code is displayed (in
 Firefox, but in other browsers too) as follows:

 {{{
 module Blah (Blah (..)) where

 -- | The 'Blah' type class.
 class Blah a where
     -- | The 'foo' method. Here is a definition list:
     --
     --     [foo] This is the foo entry of the definition list.
     --
     --     [bar] This is the bar entry of the definition list.
     foo :: a -> a

     -- | The 'bar' method.
     bar :: a -> a

 }}}

 In Firefox:

 [[Image(http://i.imgur.com/NMyfTOY.png)]]

 As you can see, it's quite confused and unreadable. The problem is to do
 with floats not being cleared properly.

 I've made a small change to ocean.css (and am attaching a patch with this
 change below) that significantly improves how the documentation for the
 above is displayed. This what it looks like now:

 [[Image(http://i.imgur.com/LjTmNXF.png)]]

-- 
Ticket URL: <http://trac.haskell.org/haddock/ticket/241>
haddock <http://www.haskell.org/haddock>
Haddock, The Haskell Documentation Tool


More information about the Haddock mailing list