Class comments!?

goran.krampe at bluefish.se goran.krampe at bluefish.se
Sun Oct 17 22:42:23 UTC 2004


Hi Andreas!

"Andreas Raab" <andreas.raab at gmx.de> wrote:
> >> All in all I have, for some people, gotten in a 'trusted mode": If
> >> there is a changeset from someone I trust (e.g. Ned, Diego, Andreas
> >> and so on...) , it gets added if there are no conflicts. Just like of
> >> they had CVS access.
> >
> > I sympathize with that. Since I also think the harvesting model is
> > too... "slow".
> >
> > But given this fact - that we now are running in a different model -
> > then IFF we want to make sure new classes do have class comments, we
> > will have to try to make that happen by some other means.
> 
> How about just filing a bug report? The nice thing about Mantis is that 
> these things don't easily get lost and therefore if we're in a release cycle 
> it's simple to nag people about it.

Agree, I will do that. Perhaps I could automate it. :)
 
> > But anyway, I am tired of arguing for this and have now officially given
> > up on my crusade for getting Squeak to have class comments and will
> > hereby never again bring up the subject.
> 
> Maybe if you would calm down a little on the subject (I really don't see why 
> this particular issue makes you so touchy)

Interesting question. Let me think... I guess it has to do with our
ambitions coupled with our seemingly inability to even do the smallest
things right. :) Like, how are we *ever* going to turn Squeak into the
exquisite artifact we all want it to become, if we can't even bother to
tell other people what our objects are?

We all know that "later" in "I will write that *later*" never comes. It
is the same for unit tests. 

> and just start treat these things 
> as bugs (as in: PluggableMumbleMorph cannot have a border width > 2) it 
> would be a little easier?

Well, only if there is a common agreement that this IS a bug. Otherwise
they will not get fixed anyway.

> I happen to agree that most classes should have 
> comments (and there are definitely various classes in m17n which may not be 
> obvious to the un-initiated) but the way to make your statement in a way 
> that doesn't get lost is simply that: File a bug report.

How can you say "most classes"? :) For which class would a MISSING class
comment be better than a SINGLE LINE class comment? I am truly curious.
 
> Cheers,
>   - Andreas

Cheers, Göran



More information about the Squeak-dev mailing list