On Dec 6, 2010, at 7:41 PM, Sean P. DeNigris wrote:
>
>
> laurent laffont wrote:
>>
>>> IMHO, before we take such a stance, we should have a package comment pane
>>> and encourage its use. A complex package is probably best documented
>>> with a
>>> good high-level description and some type o
A small script that gives the most referenced classes that are not commented:
I run the test in an image with Moose and Spy.
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
"Get the number of references per class"
d := Dictionary new.
Smalltalk allClasses do: [ :cls | cls methods do: [:cm | (cm literals select:
[:
> The good idae is to push and promote people to put class comments, but not to
> remove not commented classes from Dev, bacause otherise, you will need to
> remove 80% of the classes.
So this is simple to start fixing some of them.
I think that without such objectives we will never make any
Hi Stef,
To me class comments are not *that* useful. Most of the time I search
explanations for contexts of use, which usually involves many classes
and methods everywhere. I would remove packages which doesn't include
at least some brief or general comments of the main classes or
methods, this is
Otherwise we can find out how small the dev image can really be. . . ;-)
Em 06/12/2010 16:46, Sean P. DeNigris < s...@clipperadams.com > escreveu:
I love this idea!
Mariano Martinez Peck wrote:
>
> The good idae is to push and promote people to put class comments, but not
> to remove not c
I love this idea!
Mariano Martinez Peck wrote:
>
> The good idae is to push and promote people to put class comments, but not
> to remove not commented classes from Dev, bacause otherise, you will need
> to
> remove 80% of the classes.
>
It seemed to me this plan is being suggested precisely
laurent laffont wrote:
>
>> IMHO, before we take such a stance, we should have a package comment pane
>> and encourage its use. A complex package is probably best documented
>> with a
>> good high-level description and some type of example(s), which can take
>> the
>> form of do-its in a packag
On Mon, Dec 6, 2010 at 4:32 PM, wrote:
> Mariano,
>
> Precisely due the size of the problem as you estimated that Stef's plan is
> a Good Idea®.
>
The good idae is to push and promote people to put class comments, but not
to remove not commented classes from Dev, bacause otherise, you will need
Mariano,
Precisely due the size of the problem as you estimated that Stef's plan is a
Good Idea®.
The next step would be a Pareto classification, as it can be accepted (I hope)
that SUnit has more history (and it is documented elsewhere, like PBE book)
than other classes which even the name o
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.
On Sun, Dec 5, 2010 at 9:52 PM, Stéphane Ducasse
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 think this is not a good idea...look this approx:
...@lists.gforge.inria.fr [
> pharo-project-boun...@lists.gforge.inria.fr] On Behalf Of Stéphane Ducasse
> [stephane.duca...@inria.fr]
> Sent: Sunday, December 05, 2010 3:52 PM
> To: Pharo-project@lists.gforge.inria.fr Development
> Subject: [Pharo-project] Comments or no integration: a
gforge.inria.fr
[pharo-project-boun...@lists.gforge.inria.fr] On Behalf Of Stéphane Ducasse
[stephane.duca...@inria.fr]
Sent: Sunday, December 05, 2010 3:52 PM
To: Pharo-project@lists.gforge.inria.fr Development
Subject: [Pharo-project] Comments or no integration: a simple choice for you
Hi guys
I
Yes I agree.
Documentation is a key part of any software, without doc, all is more
hard and painful.
I would add also proper naming of things, and not use criptics things
as "el", "dr", etc that certainly don't help with the code
understanding.
Cheers.
2010/12/5 Stéphane Ducasse :
> Hi guys
>
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
15 matches
Mail list logo
