[Twisted-Python] Bugs in epydoc API docs.

Bruce Mitchener bruce at cubik.org
Tue Oct 1 05:44:37 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.

I'll look into that later.

> Also, in 0.99.2alpha3's docs (sorry, no link for you, just looking in the docs
> in moshez's debian package), in twisted.internet.protocol.html, this line is
> rendered without a hyperlink:
>    Maintainer: U{Itamar Shtull-Trauring<mailto:twisted at itamarst.org>}
> Is this a bug in epydoc, or Twisted's use of epydoc?

This is probably because there were epydoc markup errors in that block, 
so it went and made all or part of the block into a pre-formatted thing. 
  Twisted still has many many warnings and errors from epydoc that need 
to be fixed to eliminate problems like that.

  - Bruce

More information about the Twisted-Python mailing list