Re: [COTDC] 34 - MCSystemCategoryParser -- help needed, seriously

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
5 messages Options
Reply | Threaded
Open this post in threaded view
|

Re: [COTDC] 34 - MCSystemCategoryParser -- help needed, seriously

laurent laffont
Hi people,

almost no participation in COTDC last days.

I'm not a Smalltalk guru and even 30mn to look at code is sometimes not enough for me to understand some stuff alone.

I like COTDC because of http://code.google.com/p/pharo/wiki/CommentOfTheDayContest  ==> documentation.

But quality / good comment is needed and there's ~600 classes without comment remaining. So if we want a 100% good commented Pharo in 2 years from now, we should do it every day. 

Laurent Laffont

On Mon, Mar 21, 2011 at 8:36 PM, laurent laffont <[hidden email]> wrote:
Could it be:

I parse PackageInfo statement from Monticello packages file.

Laurent.



On Mon, Mar 21, 2011 at 8:02 AM, laurent laffont <[hidden email]> wrote:
Today:  MCSystemCategoryParser


Comment Of The Day Contest - One Day One Comment
Rules: 
#1: Each day a not commented class is elected. Each day the best comment will be integrated with name of the author(s).
#2: If you cannot comment it, deprecate it.
Laurent


Reply | Threaded
Open this post in threaded view
|

Re: [COTDC] 34 - MCSystemCategoryParser -- help needed, seriously

Stéphane Ducasse
continue
please continue


Stef
On Mar 22, 2011, at 8:14 AM, laurent laffont wrote:

> Hi people,
>
> almost no participation in COTDC last days.
>
> I'm not a Smalltalk guru and even 30mn to look at code is sometimes not enough for me to understand some stuff alone.
>
> I like COTDC because of http://code.google.com/p/pharo/wiki/CommentOfTheDayContest  ==> documentation.
>
> But quality / good comment is needed and there's ~600 classes without comment remaining. So if we want a 100% good commented Pharo in 2 years from now, we should do it every day.
>
> Laurent Laffont
>
> On Mon, Mar 21, 2011 at 8:36 PM, laurent laffont <[hidden email]> wrote:
> Could it be:
>
> I parse PackageInfo statement from Monticello packages file.
>
> Laurent.
>
>
>
> On Mon, Mar 21, 2011 at 8:02 AM, laurent laffont <[hidden email]> wrote:
> Today:  MCSystemCategoryParser
>
>
> Comment Of The Day Contest - One Day One Comment
> Rules:
> #1: Each day a not commented class is elected. Each day the best comment will be integrated with name of the author(s).
> #2: If you cannot comment it, deprecate it.
> Results: http://code.google.com/p/pharo/wiki/CommentOfTheDayContest
>
> Laurent
>
>


Reply | Threaded
Open this post in threaded view
|

Re: [COTDC] 34 - MCSystemCategoryParser -- help needed, seriously

laurent laffont

On Tue, Mar 22, 2011 at 1:23 PM, Stéphane Ducasse <[hidden email]> wrote:
continue
please continue


OK I will change the process a little.

One COTDC per day. If no or not satisfying comment I will not put it in results.

So I abort this one.

Laurent.

 

Stef
On Mar 22, 2011, at 8:14 AM, laurent laffont wrote:

> Hi people,
>
> almost no participation in COTDC last days.
>
> I'm not a Smalltalk guru and even 30mn to look at code is sometimes not enough for me to understand some stuff alone.
>
> I like COTDC because of http://code.google.com/p/pharo/wiki/CommentOfTheDayContest  ==> documentation.
>
> But quality / good comment is needed and there's ~600 classes without comment remaining. So if we want a 100% good commented Pharo in 2 years from now, we should do it every day.
>
> Laurent Laffont
>
> On Mon, Mar 21, 2011 at 8:36 PM, laurent laffont <[hidden email]> wrote:
> Could it be:
>
> I parse PackageInfo statement from Monticello packages file.
>
> Laurent.
>
>
>
> On Mon, Mar 21, 2011 at 8:02 AM, laurent laffont <[hidden email]> wrote:
> Today:  MCSystemCategoryParser
>
>
> Comment Of The Day Contest - One Day One Comment
> Rules:
> #1: Each day a not commented class is elected. Each day the best comment will be integrated with name of the author(s).
> #2: If you cannot comment it, deprecate it.
> Results: http://code.google.com/p/pharo/wiki/CommentOfTheDayContest
>
> Laurent
>
>



Reply | Threaded
Open this post in threaded view
|

Re: [COTDC] 34 - MCSystemCategoryParser -- help needed, seriously

Miguel Cobá
Hi Laurent,

maybe instead of random picking a class it would be better to random
picking a category and to document all the classes in that category.
That way the knowledge gained from understanding a simple class can be
re-used to document the other classes in the package (as they are very
related)
I think that by choosing a new class from a different package each day
this knowledge is lost or at least not leveraged at its full.

What do you think?

El mar, 22-03-2011 a las 18:14 +0100, laurent laffont escribió:

>
> On Tue, Mar 22, 2011 at 1:23 PM, Stéphane Ducasse
> <[hidden email]> wrote:
>         continue
>         please continue
>        
>
> OK I will change the process a little.
>
> One COTDC per day. If no or not satisfying comment I will not put it
> in results.
>
> So I abort this one.
>
> Laurent.
>
>  
>        
>         Stef
>        
>         On Mar 22, 2011, at 8:14 AM, laurent laffont wrote:
>        
>         > Hi people,
>         >
>         > almost no participation in COTDC last days.
>         >
>         > I'm not a Smalltalk guru and even 30mn to look at code is
>         sometimes not enough for me to understand some stuff alone.
>         >
>         > I like COTDC because of
>         http://code.google.com/p/pharo/wiki/CommentOfTheDayContest
>          ==> documentation.
>         >
>         > But quality / good comment is needed and there's ~600
>         classes without comment remaining. So if we want a 100% good
>         commented Pharo in 2 years from now, we should do it every
>         day.
>         >
>         > Laurent Laffont
>         >
>         > On Mon, Mar 21, 2011 at 8:36 PM, laurent laffont
>         <[hidden email]> wrote:
>         > Could it be:
>         >
>         > I parse PackageInfo statement from Monticello packages file.
>         >
>         > Laurent.
>         >
>         >
>         >
>         > On Mon, Mar 21, 2011 at 8:02 AM, laurent laffont
>         <[hidden email]> wrote:
>         > Today:  MCSystemCategoryParser
>         >
>         >
>         > Comment Of The Day Contest - One Day One Comment
>         > Rules:
>         > #1: Each day a not commented class is elected. Each day the
>         best comment will be integrated with name of the author(s).
>         > #2: If you cannot comment it, deprecate it.
>         > Results:
>         http://code.google.com/p/pharo/wiki/CommentOfTheDayContest
>         >
>         > Laurent
>         >
>         >
>        
>        
>        
>

--
Miguel Cobá
http://twitter.com/MiguelCobaMtz
http://miguel.leugim.com.mx




Reply | Threaded
Open this post in threaded view
|

Re: [COTDC] 34 - MCSystemCategoryParser -- help needed, seriously

laurent laffont
On Tue, Mar 22, 2011 at 6:33 PM, Miguel Cobá <[hidden email]> wrote:
Hi Laurent,

maybe instead of random picking a class it would be better to random
picking a category and to document all the classes in that category.
That way the knowledge gained from understanding a simple class can be
re-used to document the other classes in the package (as they are very
related)
I think that by choosing a new class from a different package each day
this knowledge is lost or at least not leveraged at its full.

What do you think?

I will try to pick related classes for one week to see (indeed today it's Monticello related too).

Laurent.

 

El mar, 22-03-2011 a las 18:14 +0100, laurent laffont escribió:
>
> On Tue, Mar 22, 2011 at 1:23 PM, Stéphane Ducasse
> <[hidden email]> wrote:
>         continue
>         please continue
>
>
> OK I will change the process a little.
>
> One COTDC per day. If no or not satisfying comment I will not put it
> in results.
>
> So I abort this one.
>
> Laurent.
>
>
>
>         Stef
>
>         On Mar 22, 2011, at 8:14 AM, laurent laffont wrote:
>
>         > Hi people,
>         >
>         > almost no participation in COTDC last days.
>         >
>         > I'm not a Smalltalk guru and even 30mn to look at code is
>         sometimes not enough for me to understand some stuff alone.
>         >
>         > I like COTDC because of
>         http://code.google.com/p/pharo/wiki/CommentOfTheDayContest
>          ==> documentation.
>         >
>         > But quality / good comment is needed and there's ~600
>         classes without comment remaining. So if we want a 100% good
>         commented Pharo in 2 years from now, we should do it every
>         day.
>         >
>         > Laurent Laffont
>         >
>         > On Mon, Mar 21, 2011 at 8:36 PM, laurent laffont
>         <[hidden email]> wrote:
>         > Could it be:
>         >
>         > I parse PackageInfo statement from Monticello packages file.
>         >
>         > Laurent.
>         >
>         >
>         >
>         > On Mon, Mar 21, 2011 at 8:02 AM, laurent laffont
>         <[hidden email]> wrote:
>         > Today:  MCSystemCategoryParser
>         >
>         >
>         > Comment Of The Day Contest - One Day One Comment
>         > Rules:
>         > #1: Each day a not commented class is elected. Each day the
>         best comment will be integrated with name of the author(s).
>         > #2: If you cannot comment it, deprecate it.
>         > Results:
>         http://code.google.com/p/pharo/wiki/CommentOfTheDayContest
>         >
>         > Laurent
>         >
>         >
>
>
>
>

--
Miguel Cobá
http://twitter.com/MiguelCobaMtz
http://miguel.leugim.com.mx