[Twisted-Python] Bugs in epydoc API docs.

Bruce Mitchener bruce at cubik.org
Tue Oct 1 09:20:52 EDT 2002


Andrew Bennetts wrote:
> E.g.
> http://twistedmatrix.com/documents/TwistedDocs/Twisted-0.99.2/twisted.internet.protocol.Protocol.html
> 
> Note the bug starting at connectionLost's description; the HTML source
> looks like this:
> 
> <a NAME="connectionLost"/>
> <h3>connectionLost</h3>
> <code><b>connectionLost(self, reason=<twisted.python.failure.Failure twisted.internet.error.Co...)</B></code><p>
> 
> Which is obviously not quite right... it leads to the rest of the page being bolded.

Well, that's really old epydoc output.

The </B> thing is no longer an issue.  The leading '<' after the reason= 
is still a problem though.  A patch to epydoc is welcome, otherwise, 
I'll keep it on my list of things to look at fixing.

  - Bruce





More information about the Twisted-Python mailing list