About OmniBrowser code :)

stéphane ducasse ducasse at iam.unibe.ch
Thu Dec 9 09:40:58 UTC 2004


On 9 déc. 04, at 06:46, Colin Putney wrote:

> Hi Stéphane,
>
> I won't reply to each point in your last message, because the amount 
> of quoted text is getting to be too unwieldy. So here's a much shorter 
> version:
:)
>
> About class comments. I agree that class comments are important, but I 
> don't think what I posted earlier in this thread should go into them. 
> I like to keep the class comment focused on the class its self - its 
> responsibilities and the other objects it collaborates with. 
> Big-picture explanations and tutorials can go elsewhere. I have some 
> ideas for an active essay I'd like to write soon, and the OmniBrowser 
> wiki also has documentation.

Sure but think about the poor guys in the train (like me) or over a 
really slow modem lost in the french country side (like me too). 
Because having a readme file on a key class can really help. I prefer 
having more comments than less.

> Although it hasn't been updated recently, it's still accurate; the 
> core of OB hasn't changed in quite a while. (See 
> http://www.wiresong.ca/OmniBrowser/Docs/)
>
> About categorizing methods: I don't think there are very many 
> uncategorized methods in OB. I'm really annoyed by that, so I tend to 
> categorize them as I go. Also, I've made Ned's ENH available in 
> OmniBrowser. I think the menu item is something like "categorize 
> automatically."

Cool. So this is in the image then because I was planning to chase it 
for seaside. :)

> About the hierarchy browser: I wonder if you were thinking of 
> OBInheritanceBrowser. It displays the inheritance of methods, not 
> classes.

Ok.

Stef




More information about the Squeak-dev mailing list