Class comments (was Re: ProtoObject?)

agree at carltonfields.com agree at carltonfields.com
Wed Feb 9 20:24:52 UTC 2000


Another, perhaps simpler, solution, might be to set up a mailing list JUST for class documentation.  Each entry would comprise a subject that is the title, and the text would comprise ONLY the (very short) changeset instructions necessary to adjust the class comment field only.  Perhaps, with the word ***DRAFT*** or some such to indicate that the proposal has yet to be communally blessed.

This would permit the simplest form of automation -- a browser could be modified to send e-mail via the net in proper form to the e-mail service.  Those who want to read through these suggestions can do so (or file them in), and other software could be modified simply to load and install them.  Some volunteer can archive the mailing list, perhaps edit it, and an updated changeset can be constructed, and formally issued, with each official update list.

What I am seeking is a solution that requires: (1) the least amount of actual automation and administration; but also (2) the least amount of effort to manage and implement the changes for eventual inclusion in the central release.

> -----Original Message-----
> From: MIME :eat at IBM.NET > Sent: Wednesday, February 09, 2000 2:15 PM
> To: squeak at cs.uiuc.edu
> Subject: RE: Class comments (was Re: ProtoObject?)
> > > I seem to recall someone mentioning that we should have a > sign-out mechanism
> and a way to track the comments for the classes.  How about > we use a Wiki,
> with a top level page for each system category.  This would > allow everyone
> to peruse, fix, check, add and have version history.  I think > this would
> simplify the whole exercise.  It might make it more difficult > for some of
> the dynamic object behavior that has been talked about, but > we can at least
> get a good starting point to the text version.
> > Just a thought
> > > > 





More information about the Squeak-dev mailing list