[Twisted-Python] API Documentation error discovered
Sergio Trejo
serj_trejo at hotmail.com
Sat Jul 31 07:31:21 MDT 2004
I found a minor error in the API documentation.
Please go to:
http://www.twistedmatrix.com/documents/current/api/twisted.internet.interfaces.IReactorTCP.html#connectTCP
In this block of text:
-------------------------------------------------------------------------------------
Returns:
An object implementing IConnector. This connector will call various
callbacks on the factory when a connection is made, failed, or lost - see
ClientFactory docs for details.
-------------------------------------------------------------------------------------
The text, "ClientFactory" has a hyper link that incorrectly links to:
http://www.twistedmatrix.com/documents/current/api/twisted.internet.protocol.ServerFactory.html
Instead it should link to:
http://www.twistedmatrix.com/documents/current/api/twisted.internet.protocol.ClientFactory.html
Hope this is helpful ... I am nowhere near wizard status when it comes to
adding code to Twisted, but I will continue to contribute to Twisted by
chugging through the documentation and reporting errors, and will try to ask
intelligent questions if something seems ambiguous (like the SMTP library
docs the other day with "local" line endings).
Cheers,
-Serg
_________________________________________________________________
The new MSN 8: smart spam protection and 2 months FREE*
http://join.msn.com/?page=features/junkmail
More information about the Twisted-Python
mailing list