There are many undocumented classes left in the system

    Object allSubclasses 
             select: [:each | each comment includesSubstring: 'xxxxx' ]

Exactly 2731 by now in Pharo3.0 Latest update: #30731. Around 400 classes are 
test classes
with a pair class that they test as a test unit and I think these can easily 
include
a comment like "This is a test class for ...". The other ones are left for 
humans.
  
With the new release we have the chance:

 - to improve also on this side which would especially help newcomers after 
grabbing the new release
   and browsing around
 - to add class comments before the release date 31.3.2014 since they are safe 
to integrate


SO PLEASE: add class comments for traits, athens-text, compiler, compression, 
debugger, 
           filesystem, ...
           Even a short comment makes more sense than no comment!

Maybe we should add a test to ReleaseTest class that forces us to do it and 
that stays red until 
the situation improved.

Maybe also a check to have no uncategorized methods left.

Thx
T.

Reply via email to