As a new reader of Pharo code I have frequently been dismayed at the
lack of even the most cursory comments for many of the classes.

Yes, good code (short methods, good names, etc.) doesn't require
commenting, but a brief overview of a class's purpose and essential
processing can help quite a lot. Examples of common usage patterns are
essential if you want people to use the class properly.

Good decision.

TF

On Sun, Dec 5, 2010 at 12:52 PM, Stéphane Ducasse
<[email protected]> wrote:
> Hi guys
>
> I decided that I will not integrate any code that is not documented in Pharo.
>
> I strongly suggest to remove from Pharo-dev packages whose classes are not 
> commented.
> I'm not sure that I will look at code or answer question to code that is not 
> commented.
> We should change our mindset and it seems that we do not care, so we should 
> take radical decisions:
>        less changes, less progress, more comments.
>
> And for once I will not bash the past. Smalltalk was always with methods 
> fully documented.
> We are just plain lazy and this is a shame.
>
> Stef
>

Reply via email to