[haddock] #57: haddock doubles ^Ms

haddock haddock at projects.haskell.org
Sat Feb 28 10:39:54 EST 2009


#57: haddock doubles ^Ms
-------------------+--------------------------------------------------------
Reporter:  igloo   |        Owner:        
    Type:  defect  |       Status:  closed
Priority:  major   |    Milestone:  2.4.2 
 Version:          |   Resolution:  fixed 
Keywords:          |  
-------------------+--------------------------------------------------------
Changes (by waern):

  * status:  new => closed
  * resolution:  => fixed

Comment:

 The problem is that doc strings can contain CRLF line endings. Both the
 HTML and Hoogle backend are written with the assumption that line endings
 are represented by LF only (since this is the assumption taken by the
 Haskell String functions such as lines, unlines and even IO commands such
 as hPutStr which inserts CRs before LFs?). So we should let LF be our
 internal format and convert to it in the doc string lexer.

 This patch for GHC should do it:
 {{{
 Sat Feb 28 15:53:51 CET 2009  David Waern <david.waern at gmail.com>
   * Filter out carriage returns in doc strings

   We want the internal format to contain LFs only. This makes it easier to
 work
   with the doc strings for clients of the GHC API.
 }}}

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


More information about the Haddock mailing list