Hi Stef, I think your mail can easily be misunderstood to say that Filesystem is crap and that the authors did a bad job. I believe your intention was simply to push people to write more comments and give Filesystem as an example of a fine system that does not have comments :). Filesystem is a nice piece of work and the authors did a good job. I understand that there are no comments, but the documentation found on Lukas' website provides a better overview than most class comments in Pharo: http://www.lukas-renggli.ch/blog/filesystem-1 http://www.lukas-renggli.ch/blog/filesystem-2 So, why not just copy these into the help system? Cheers, Doru On 27 Jan 2011, at 09:59, Igor Stasenko wrote:
On 26 January 2011 21:45, Stéphane Ducasse <stephane.ducasse@inria.fr> wrote:
Hi guys,
I was checking the state of FileSystem and we cannot push it into pharo like that! Sad but we should not put code where not a single method has a comment. So instead of crying and bashing colin, I started a while ago to understand (great pain) and write comments probably wrong, of course. Now I did several iterations but not enough. So I will read the blog entries of lukas and try to continue.
http://www.lukas-renggli.ch/blog/filesystem
Now if you want pharo to evolve, then this is clearly a place to help. We should get better class comments, and all the methods with a comment. Else FileSystem will not get integrated. I will veto it.
Is it incomplete , or it just not well documented? I understand that new things require documentation because people won't know how to use it, but what about functionality?
Colin lost all the changes he did after ESUG so we will have to live with that (for example FSPath not being a class for public consumption and others).
Stef
-- Best regards, Igor Stasenko AKA sig.
-- www.tudorgirba.com "Yesterday is a fact. Tomorrow is a possibility. Today is a challenge."