Ticket #5764 defect new
t.w.p.i.IRCClient's API documentation is incomplete
| Reported by: | Jonno_FTW | Owned by: | |
|---|---|---|---|
| Priority: | normal | Milestone: | |
| Component: | web | Keywords: | irc, ircclient, api docs, documentation |
| Cc: | jknight | Branch: | |
| Author: | Launchpad Bug: |
Description
I started using for the first time twisted yesterday as I wanted to make a new IRC bot. I found the documentation below:
http://twistedmatrix.com/documents/current/api/twisted.words.protocols.irc.IRCClient.html
I could not find the method names to the numeric server responses listed and had to search through the source code for the following lookup table:
All these method names should be listed in the docs with meaningful descriptions.
Personally, I feel that users shouldn't have to read the source code to find a lookup table to see what API methods are available.
Change History
Note: See
TracTickets for help on using
tickets.
