[Haddock] [haddock] #126: multi-line emphasis not working

haddock haddock at projects.haskell.org
Fri Aug 23 02:45:57 BST 2013

#126: multi-line emphasis not working
Reporter:  waern        |        Owner:     
    Type:  enhancement  |       Status:  new
Priority:  minor        |    Milestone:     
 Version:  2.5.0        |   Resolution:     
Keywords:               |  

Comment(by Fūzetsu):

 I have considered it for a while and even put the functionality in to test
 it. In the end I think that multi-line markup would be used far less than
 the individual markup tokens on their own lines and you'd end up escaping
 tokens everywhere far more than actually getting use out of this

 Something that I haven't considered before however was use of a rarer
 string sequence. For example, instead of having

 -- | /Multi
 -- line
 -- string/

 and having to escape ‘/’ in all documentation comments where we have pairs
 of the same token, we could do something like
 -- | ///Multi
 -- line
 -- string///

 I have not discussed this with anyone yet though and I'd have to give it
 further thought.

 Do you actually end up wanting to use multi-line markup often? This issue
 has been around for years but no one seemed to express their interest in
 it until recently so I can't imagine it's of very high priority and I'd
 rather avoid annoying the larger part of the userbase for the sake of
 convenience of few people.

 >In any case, I think "enhancement" is a better type for this issue. After
 all, the implementation is not supposed to work in this way.
 I agree, well changed.

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

More information about the Haddock mailing list