[Haddock] [haddock] #252: Allow markdown inside of emphasis (was: HTML codes and emphasized blocks)
haddock
haddock at projects.haskell.org
Mon Aug 12 17:55:50 BST 2013
#252: Allow markdown inside of emphasis
------------------------+---------------------------------------------------
Reporter: DanielDiaz | Owner: Fūzetsu
Type: enhancement | Status: new
Priority: minor | Milestone:
Version: 2.11.0 | Resolution:
Keywords: |
------------------------+---------------------------------------------------
Changes (by Fūzetsu):
* owner: => Fūzetsu
* type: defect => enhancement
Comment:
First case: that's right, you currently can not have anything but plain
text inside of emphasis: the parser simply swallows up everything until a
‘/’. This is also the behaviour in the new parser I wrote simply because
the first goal for it was to reproduce the old behaviour exactly. I have
discussed this problem very briefly with Simon Hengel just over a week ago
and the general opinion seems that it would be nice to be able to have
markup inside of emphasis (note that I have currently implemented support
for bold text (with 2 underscores) which also exhibits this rather nasty
behaviour) and I would be all for it. It is certainly possible to do with
the new parser and the implementation wouldn't be very difficult. The only
obstacle is that I have no data on how much old documentation this would
change and I'd like to have some numbers to back the change up. I do think
that this is a nice change and that in the end, it will be put in.
For this very same reason, HTML codes aren't converted. It is certainly
something that can be addressed. I will do some research into how much
documentation would potentially change (to worse) but I suspect the answer
will be that the benefit far outweighs any changes.
Regards multi-line emphasis: this is known, have a look at ticket #126
from years ago where I ask whether there's actually interest with this.
While the implementation is certainly possible (if not quite as simple as
the previous one), I am more reluctant about implementing this. With the
old parser, a single unescaped ‘/’ on a line would make the parsing fail.
With the current parser, it gets treated as plain text. In light of this,
do you believe that multi-line emphasis is more common than single ‘/’ on
a line on its own? In the end, I just don't think that multi-line emphasis
warrants the additional parsing complexity and syntax rules. I would
appreciate it if you could reply to this part of the ticket on the ticket
#126.
I'm changing the summary to deal with allowing markdown inside of emphasis
and the other part of the discussion can be carried on in #126.
Sorry for late reply, I had problem with e-mail that I was not aware of
until today.
--
Ticket URL: <http://trac.haskell.org/haddock/ticket/252#comment:1>
haddock <http://www.haskell.org/haddock>
Haddock, The Haskell Documentation Tool
More information about the Haddock
mailing list