As the FNG, class comments are very important to me. I propose:
We should ship a release soon. That's maybe the most important thing in the
universe right now. That said, as the FNG, I would like to propose a general
standard:

- There should be an informative class comment for each class in the base
image.
- Within reason, classes which are in the core image should have a comment
written in a consistent style (e.g., "I represent...")
- It's okay to ship a release without meeting the above two objectives, as
long as we make progress toward the above two objectives.

I personally would not mind wandering the image, looking for crappy or
missing class comments, fixing them where I can, and asking the list for
advice where I can't. I imagine that I could learn a lot that way:)

What do the lovely people of squeak-dev think?

  - Ron, the FNG

P.S.

For those not-in-the-know, the 'NG' in FNG stands for New Guy. I can't
remember that the 'F' stands for.

On Wed, Aug 12, 2009 at 9:44 AM, John M McIntosh <
johnmci at smalltalkconsulting.com> wrote:

>
> On 12-Aug-09, at 9:20 AM, Simon Michael wrote:
>
>  Good morning Squeakers! Speaking of class comments, and now that there is
>> a new committing process, I wanted to check something: is it generally
>> agreed that we'd like every class in the system commented ? Retroactively,
>> if not when first created ?
>>
>> I can't think why not, but I'm asking since comment-less classes have
>> persisted for such a long time.
>>
>>
> Ooh I can't resist, I've the source code for sq3.10.2-7179web09.07.1 as an
> iPhone ebook. Well actually it's a WikiServer image with a
> bit of work to the code browser to make it work with Mobile Safari.
>
> It has one 2 star comment
>
>  "Many classes and methods don't have comments. Not so useful for newBs."
>
>
> --
> ===========================================================================
> John M. McIntosh <johnmci at smalltalkconsulting.com>   Twitter:
>  squeaker68882
> Corporate Smalltalk Consulting Ltd.  http://www.smalltalkconsulting.com
> ===========================================================================
>
>
>
>
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.squeakfoundation.org/pipermail/squeak-dev/attachments/20090812/2dd920b8/attachment.htm