Opened 2 years ago

Last modified 2 years ago

#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:

http://twistedmatrix.com/trac/browser/tags/releases/twisted-12.1.0/twisted/words/protocols/irc.py#L3158

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 (2)

comment:1 Changed 2 years ago by DefaultCC Plugin

  • Cc jknight added

comment:2 Changed 2 years ago by thijs

  • Milestone regular-releases deleted
Note: See TracTickets for help on using tickets.