As the FNG, class comments are very important to me. I propose:<div><br></div><div>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:</div>
<div><br></div><div>- There should be an informative class comment for each class in the base image.</div><div>- Within reason, classes which are in the core image should have a comment written in a consistent style (e.g., "I represent...")</div>
<div>- It's okay to ship a release without meeting the above two objectives, as long as we make progress toward the above two objectives.</div><div><br></div><div>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:)</div>
<div><br></div><div>What do the lovely people of squeak-dev think?<br><br></div><div> - Ron, the FNG</div><div><br></div><div>P.S.</div><div><br></div><div>For those not-in-the-know, the 'NG' in FNG stands for New Guy. I can't remember that the 'F' stands for.</div>
<div><br><div class="gmail_quote">On Wed, Aug 12, 2009 at 9:44 AM, John M McIntosh <span dir="ltr"><<a href="mailto:johnmci@smalltalkconsulting.com">johnmci@smalltalkconsulting.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">
<div class="im"><br>
On 12-Aug-09, at 9:20 AM, Simon Michael wrote:<br>
<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
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 ?<br>
<br>
I can't think why not, but I'm asking since comment-less classes have persisted for such a long time.<br>
<br>
</blockquote>
<br></div>
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<br>
bit of work to the code browser to make it work with Mobile Safari.<br>
<br>
It has one 2 star comment<br>
<br>
"Many classes and methods don't have comments. Not so useful for newBs."<br><font color="#888888">
<br>
<br>
--<br>
===========================================================================<br>
John M. McIntosh <<a href="mailto:johnmci@smalltalkconsulting.com" target="_blank">johnmci@smalltalkconsulting.com</a>> Twitter: squeaker68882<br>
Corporate Smalltalk Consulting Ltd. <a href="http://www.smalltalkconsulting.com" target="_blank">http://www.smalltalkconsulting.com</a><br>
===========================================================================<br>
<br>
<br>
<br>
<br>
<br>
</font></blockquote></div><br></div>