Improving comments cool action

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

Improving comments cool action

stepharo
Hi guys

I would like to see how we could build a concerted action to improve the
class and method comments in Pharo.

Now we have package comments :) so we should take also advantage of them.

I would love that a newbie is highlithed by class comments.

So I would like to start to comment key core classes.

I'm sure that if we all spend 30 min per week we can really have a huge
impact.

I was planning to start with collection classes.

Now let me know if you want to help.

Stef


Reply | Threaded
Open this post in threaded view
|

Re: Improving comments cool action

Sven Van Caekenberghe-2
More and better documentation, I am all for it.

> On 20 Nov 2016, at 17:26, stepharo <[hidden email]> wrote:
>
> Now we have package comments :) so we should take also advantage of them.

Stupid question, how exactly does one add package comments ? Can it only be done in the latest 6 ? Is it somehow compatible with older versions ?
Reply | Threaded
Open this post in threaded view
|

Re: Improving comments cool action

stepharo
>> Now we have package comments :) so we should take also advantage of them.
> Stupid question, how exactly does one add package comments ? Can it only be done in the latest 6 ? Is it somehow compatible with older versions ?
>
In latest version you press on a package and comment and you can accept
text.

Is it somehow compatible with older versions ?

I do not know. I did not check its implementation.
I imagine that the package comments is stored in the manifest. So it is
probably not displayed but not lost if you load your package in Pharo 50.


Reply | Threaded
Open this post in threaded view
|

Re: Improving comments cool action

Nicolai Hess-3-2


2016-11-20 22:06 GMT+01:00 stepharo <[hidden email]>:
Now we have package comments :) so we should take also advantage of them.
Stupid question, how exactly does one add package comments ? Can it only be done in the latest 6 ? Is it somehow compatible with older versions ?

In latest version you press on a package and comment and you can accept text.

Is it somehow compatible with older versions ?

I do not know. I did not check its implementation.
I imagine that the package comments is stored in the manifest. So it is probably not displayed but not lost if you load your package in Pharo 50.


Yes, it is stored as a class side method (#description) on the package manifest class