[haddock] #83: Better parse error messages when parsing the contents of Haddock comments

haddock haddock at projects.haskell.org
Sun Feb 22 07:44:10 EST 2009


#83: Better parse error messages when parsing the contents of Haddock comments
------------------------+---------------------------------------------------
Reporter:  waern        |        Owner:       
    Type:  enhancement  |       Status:  new  
Priority:  major        |    Milestone:  2.6.0
 Version:  2.4.1        |   Resolution:       
Keywords:               |  
------------------------+---------------------------------------------------
Comment (by duncan):

 Just having file names and line numbers would be good. For example I got
 this error:

 {{{
 haddock: parse error in doc string
 }}}

 Nothing else. No idea what is wrong, not even sure what file to look in.

 Turns out it was due to this:

 {{{
 module Foo (
   -- * some top level section name
   something,

   -- **
   somethingElse,
   ) where
 }}}

 So it was just that I'd not filled in the subsection name yet. I presume
 that if there had been an error in the markup within that subsection name
 that it would have shown me the full thing. However since the problem was
 that it was blank, showing me the blank markup is rather confusing.

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


More information about the Haddock mailing list