Call for Action! ...or "The Holy Crusade Against Empty Class Comments"

goran.hultgren at goran.hultgren at
Thu Apr 18 10:50:39 UTC 2002

John M McIntosh <johnmci at> wrote:
> >
> >Should I whip up some code to produce the tables for the Swiki as my
> >little plan suggests?
> >
> >regards, GÐran
> Mmm you should read the man pages in os-x then review the code then
> wonder why someone hasn't updated the 20 year old comment to match
> the current code base.
> however I digress.
> Are you saying we could stick all the comments (all, current
> obsolete/broken ones, missing) on a swiki somewhere (arranged by some
> magical structure) where many could visit and write/fix/update from
> time to time, then these get rolled into changesets from time to time
> and roll back into the update stream?

Nope, not exactly. I meant that we make a table (like the harvester
table) on the Swiki where people can "sign up" for one or more classes
that they will spend a day or two to produce a good class comment which
they then post as a regular ENH. The table will not contain the comments
themselves - the table is just for making sure we don't duplicate work.

The ENHs should have the special convention I wrote so that the
harvesters know that those ENHs are only a comment on a class that had
no comment at all before. Of course we should read the comments before
we apporove them but it will make it easy to grab all those ENHs in one
swoop as a harvester, read them through and fasttrack them.

> mmm pulling the ones from VW-NC might be interesting just to enable a
> comparison.
> Mmm having a few standards is helpful. Like how to create an viable
> instance of this class (if appropriate) IE VMMakerTool has a comment
> like that. It make it easy, visit the comment, do it on the example.

Sure, but I would settle for just getting SOMETHING instead of nothing
at all. :-)

regards, Göran

More information about the Squeak-dev mailing list