Erlang/OTP Forums

Author Message

<  Erlang bugs mailing list  ~  Wrong transform of eunit docs from edoc to html

t
Posted: Sun Jul 25, 2010 2:17 pm Reply with quote
User Joined: 30 Sep 2008 Posts: 133
Part of lib/eunit/doc/overview.edoc happens to be transformed into
mis-formatted html. Is this a problem in the edoc source or the
transformation process?

Is this a problem in xsltproc, edoc, or the edoc sources?

The following source from lib/eunit/doc/overview.edoc

--->8---
To make the descriptions simpler, we first list some definitions:
<center>
<table border="0" cellspacing="4">
<tr>
<td>`Setup'</td><td>`() -> (R::any())'</td>
</tr>
<tr>
<td>`SetupX'</td><td>`(X::any()) -> (R::any())'</td>
</tr>
<tr>
<td>`Cleanup'</td><td>`(R::any()) -> any()'</td>
</tr>
<tr>
<td>`CleanupX'</td><td>`(X::any(), R::any()) -> any()'</td>
</tr>
<tr>
<td>`Instantiator'</td><td>`((R::any()) -> Tests) | {with,
[AbstractTestFun:Sad(any()) -> any())]}'</td>
</tr>
<tr>
<td>`Where'</td><td>`local | spawn | {spawn, Node::atom()}'</td>
</tr>
</table>
</center>
(these are explained in more detail further below.)
--->8---

is transformed into the ill-formatted HTML

---8<---
<p>To make the descriptions simpler, we first list some definitions:
<strong>


Setup() -&gt; (R::any())


SetupX(X::any()) -&gt; (R::any())


Cleanup(R::any()) -&gt; any()


CleanupX(X::any(), R::any()) -&gt; any()


Instantiator((R::any()) -&gt; Tests) | {with,
[AbstractTestFun:Sad(any()) -&gt; any())]}


Wherelocal | spawn | {spawn, Node::atom()}


</strong>
(these are explained in more detail further below.)</p>
--->8---

This is harder to read and also contains the faulty string 'Wherelocal'.

I think it should be rather transformed into something like:

---8<---
<p>To make the descriptions simpler, we first list some definitions:
<pre>
Setup() -&gt; (R::any())

SetupX(X::any()) -&gt; (R::any())

Cleanup(R::any()) -&gt; any()

CleanupX(X::any(), R::any()) -&gt; any()

Instantiator((R::any()) -&gt; Tests | {with,
[AbstractTestFun:Sad(any()) -&gt; any())]}

Where local | spawn | {spawn, Node::atom()}
</pre>
(these are explained in more detail further below.)</p>
--->8---

________________________________________________________________
erlang-bugs (at) erlang.org mailing list.
See http://www.erlang.org/faq.html
To unsubscribe; mailto:erlang-bugs-unsubscribe@erlang.org

Post received from mailinglist
View user's profile Send private message

Display posts from previous:  

All times are GMT
Page 1 of 1
This forum is locked: you cannot post, reply to, or edit topics.

Jump to:  

You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum
You cannot attach files in this forum
You cannot download files in this forum