Class comments need review (English speakers welcome)

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

Class comments need review (English speakers welcome)

CyrilFerlicot
Hi!

I begun to improve the comments of Collection Sequenceable's classes. I
would like the community to review few things:
- The English! Since I learned English on video games let's say that my
level in far from been perfect :) I most probably made mistakes and I
would like English speakers to review that part.
- The content. Maybe I wrote bad/useless informations? Maybe I forgot
something? Maybe there is an implementation detail you know and that
deserve to be in the comment? Maybe you have a cool example to add?
- I did not improved the comment of some classes because I don't have
enough knowledge on them. (Mostly SharedQueue, SparseLargeTable,
SparseLargeArray) It would be welcome that people improve those
comments. Or if you don't want to do it you can send me a message with a
description of the class and example of usages in the system (since I
think that they are used by the core of Pharo).

I mostly changed those classes comment:
- Interval
- LinkedList
- OrderedCollection
- SortedCollection
- OrderedDictionary
- OrderedIdentityDictionary

If you want to help you can merge this slice from Pharo50Inbox:

Name:
SLICE-Issue-16945-Improve-Collection-Sequenceable-comments-CyrilFerlicot.3
Author: CyrilFerlicot
Time: 26 March 2016, 9:50:43.042998 pm
UUID: 54adf1ee-27e4-49e3-ab07-2552486f5f62
Ancestors:
SLICE-Issue-16945-Improve-Collection-Sequenceable-comments-CyrilFerlicot.2
Dependencies: Collections-Sequenceable-CyrilFerlicot.238

add example to OrderedIdentityDictionary


Thank you in advance for your help! Let's make Pharo a user friendly
environment. :)

--
Cyril Ferlicot

http://www.synectique.eu

165 Avenue Bretagne
Lille 59000 France


signature.asc (817 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: Class comments need review (English speakers welcome)

stepharo
Cool cyril

What I was thinking is to copy what we wrote in the Pharo by example



Le 26/3/16 21:53, Cyril Ferlicot Delbecque a écrit :

> Hi!
>
> I begun to improve the comments of Collection Sequenceable's classes. I
> would like the community to review few things:
> - The English! Since I learned English on video games let's say that my
> level in far from been perfect :) I most probably made mistakes and I
> would like English speakers to review that part.
> - The content. Maybe I wrote bad/useless informations? Maybe I forgot
> something? Maybe there is an implementation detail you know and that
> deserve to be in the comment? Maybe you have a cool example to add?
> - I did not improved the comment of some classes because I don't have
> enough knowledge on them. (Mostly SharedQueue, SparseLargeTable,
> SparseLargeArray) It would be welcome that people improve those
> comments. Or if you don't want to do it you can send me a message with a
> description of the class and example of usages in the system (since I
> think that they are used by the core of Pharo).
>
> I mostly changed those classes comment:
> - Interval
> - LinkedList
> - OrderedCollection
> - SortedCollection
> - OrderedDictionary
> - OrderedIdentityDictionary
>
> If you want to help you can merge this slice from Pharo50Inbox:
>
> Name:
> SLICE-Issue-16945-Improve-Collection-Sequenceable-comments-CyrilFerlicot.3
> Author: CyrilFerlicot
> Time: 26 March 2016, 9:50:43.042998 pm
> UUID: 54adf1ee-27e4-49e3-ab07-2552486f5f62
> Ancestors:
> SLICE-Issue-16945-Improve-Collection-Sequenceable-comments-CyrilFerlicot.2
> Dependencies: Collections-Sequenceable-CyrilFerlicot.238
>
> add example to OrderedIdentityDictionary
>
>
> Thank you in advance for your help! Let's make Pharo a user friendly
> environment. :)
>


Reply | Threaded
Open this post in threaded view
|

Re: Class comments need review (English speakers welcome)

CyrilFerlicot


On 27/03/2016 11:42, stepharo wrote:
> Cool cyril
>
> What I was thinking is to copy what we wrote in the Pharo by example
>
>

For each class I read the PBE part on Collection's chapter to see if I
covered enough things in the comment.

--
Cyril Ferlicot

http://www.synectique.eu

165 Avenue Bretagne
Lille 59000 France


signature.asc (817 bytes) Download Attachment