Ed Leafe wrote:
> On Mar 16, 2007, at 10:54 PM, Paul McNett wrote:
> 
>> Anyway, I think the class docstring should explain what the class does
>> in a high-level fashion, and that the method docstrings should explain
>> what the method does as well as what the arguments do, if it isn't  
>> obvious.
> 
>       It was put at the class level because there are many places where  
> that same explanation would have to go. I had thought that maybe John  
> had mentioned this to you, since we talked about it yesterday during  
> an interactive session. Duplicating the info in one method would only  
> take care of one case, not them all.

Ok, see my last commit. I wrote the additional docstring once, but yet 
it gets appended to each applicable method.

My only concern is that the docstring is too long for displaying as a 
tooltip.

-- 
pkm ~ http://paulmcnett.com


_______________________________________________
Post Messages to: [email protected]
Subscription Maintenance: http://leafe.com/mailman/listinfo/dabo-dev

Reply via email to