[ENH]browserNagIfNoClassComment

Karl Ramberg karl.ramberg at chello.se
Mon Oct 27 17:17:59 UTC 2003



Lex Spoon wrote:
> 
> This kind of idea has gone around before, and there are lots of ideas on
> the best way to do the nagging.  My taste would be not to have a
> notifier pop up, mainly because this is a little too strong of a nag.
> Also, it bothers me to stop as soon as every class has one comment, but
> we also need to worry about getting old comments updated.

Yes, it's a very annoying nag :-) But since I added it I 
have written about 10 class comments :-)
And note that it is a preference so it can be turned off.
And once all classes have a comment the nag should be turned off, but 
there is around 700 uncommented classes in the image, so there is some 
way to go.

> 
> My favorite "nagging" approach would be to include the comment in the
> class definition window.  That way people see it all the time.  It would
> be just like with methods: whenever you browse to a method/class, the
> second thing you see is the method's/class's comment.  I ran my image
> for a while in this way and I found it very smooth.  For once I actually
> knew a little about the class comments in my image.  Somehow I never got
> in the habit of manually clicking "?".

I would like this feature. Do you have the code around or a link to it ?
Maybe we can add it to the myriad of other preferences :-)

Karl



More information about the Squeak-dev mailing list