Documentation Suggestion
Lex Spoon
lex at cc.gatech.edu
Fri Sep 22 14:08:26 UTC 2000
mdr at scn.org (Mike Rutenberg) wrote:
> I took a cut at this with the simple change set I posted which annotates
> the displayed class definition if there is no class comment. It is just
> a small gentle reminder, the goal being that if I am working on a class
> I know well and I see that there is not a comment, I am likely to
> quickly add one. (Date: 25 Aug 2000, Subject: [ENH] gentle encouragement
> to add a class comment)
>
Oh yeah, that was a great idea!
> p.s. Other tools or presentations related to class information are also
> imaginable. The browser "?" could be grey if there is no documentation
> and get more and more black bold as the class comment gets longer
> (better?).
Another nice thing would be to add it to the "check for slips" that is done
when a changeset is filed out.... Certainly class methods should be
checked, and a real documentation fanatic might want to have each
*method* checked, as well.
-Lex
More information about the Squeak-dev
mailing list
|