Author j1m
Recipients akuchling, djarb, facundobatista, forest, giampaolo.rodola, gvanrossum, intgr, j1m, jafo, josiahcarlson, kevinwatters, markb, mcdonc, stutzbach, tseaver
Date 2009-04-02.19:57:38
SpamBayes Score 1.48547e-10
Marked as misclassified No
Message-id <CC32E67A-14FD-47A8-B446-4FB913699555@zope.com>
In-reply-to <1238700910.13.0.460809917496.issue1641@psf.upfronthosting.co.za>
Content
On Apr 2, 2009, at 3:35 PM, Josiah Carlson wrote:

>
> Josiah Carlson <josiahcarlson@users.sourceforge.net> added the  
> comment:
>
> I'm not defending the documentation, I'm merely reposting it.
>
> The documentation for asyncore says, "The full set of methods that can
> be overridden in your subclass follows:"
>
> The documentation for asynchat says, "To make practical use of the  
> code
> you must subclass async_chat, providing meaningful
> collect_incoming_data() and found_terminator() methods. The
> asyncore.dispatcher methods can be used, although not all make sense  
> in
> a message/response context."
>
> How can we make the documentation better?  I'm too close to the
> documentation to really know how to improve it.  Ideas?

Actually, the documentation is better than I remember it to be. The  
problem is that subclassing is a much more intimate interface between  
components that a call interface.  In the case of asyncore, the  
methods being overridden have non-trivial default implementations.  
Overriding methods often entails studying the base-class code to get  
an idea how it should be done. The subclassing interface for asynchat  
appears to be much cleaner, but even then, you need to study the base  
class code to make sure you haven't accidentally overridden any base  
class attributes.  I wish classes that exposed subclassing interfaces  
were more careful with their internal names.

Jim
History
Date User Action Args
2009-04-02 19:57:40j1msetrecipients: + j1m, gvanrossum, akuchling, facundobatista, jafo, josiahcarlson, tseaver, forest, giampaolo.rodola, kevinwatters, djarb, stutzbach, markb, intgr, mcdonc
2009-04-02 19:57:38j1mlinkissue1641 messages
2009-04-02 19:57:38j1mcreate