Why seaside really sucks! COMMMMMMMENTS are MISSING

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

Why seaside really sucks! COMMMMMMMENTS are MISSING

stephane ducasse
This is not easy for me to say that because I appreciate the work of  
Avi, Lukas and Philippe.
But I'm sorry to say that but seaside sucks! Not because of the code  
or the concepts.
But because there is really not enough comments. Really! It is really  
difficult to understand a simple
method is doing and if it makes sense to specialize it.

This is TERRIBLE since I think that I'm a good programmer but seaside  
code prevents me to
be fully efficient. I have to guess try and error and guess again. I  
have to ask stupid questions to the mailing-list
while I would prefer to use it for  interesting questions. I think  
that seaside goes even against the philosophy of
Smalltalk (a system that someone alone can understand) because this  
total lacks of
comments is TRAPPING me. I cannot use my skills full speed. Thanks  
what a great feeling.
pleaseeeeeee do not tell me to read the code or to use senders! This  
is really the worse answer I can get.
I always hated this kind of answer on smalltalk forums.

(Please do not ask me what I'm doing to improve the situation because  
people knows what I did
for seaside and Smalltalk already.)

I think that as a community we should do something especially since  
we have monticello
and comments could be easily merged.

I pushed a lot seaside and I'm trying to push it again further but  
come on we should WAKE UP!
I would really like that people with knowledge helps improving the  
situation.

So if you think that seaside is cool and it is worth more, spend 30  
min of your precious time and
add comments, help lukas and the other to make Seaside really a  
habitable piece of code.

Comments are for people that do not know or remember. So if you  
really want to make the community
grow you know what you should do. But may be it is better that  
seaside stays a cool program for a nice and
private club after all.

Stef

PS: I should say that filelibrary is a good start at documenting a  
functionality. May be adding method comments
would help there too.

_______________________________________________
Seaside mailing list
[hidden email]
http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
Reply | Threaded
Open this post in threaded view
|

Re: Why seaside really sucks! COMMMMMMMENTS are MISSING --> <<<<< SI - UNITS >>>>>

Maarten Mostert-2
Well I think what Seaside is missing is SI Unit test.

If you have some experience with Glorp or Polluck then you know that
these are both complicated things to handle.

Being able to search working models for almost everething however is
really assuring, improves the quality of the products and certainly
saves a lot of time end effort for everybody.

@+Maarten,

stephane ducasse a écrit :

> This is not easy for me to say that because I appreciate the work of
> Avi, Lukas and Philippe.
> But I'm sorry to say that but seaside sucks! Not because of the code
> or the concepts.
> But because there is really not enough comments. Really! It is really
> difficult to understand a simple
> method is doing and if it makes sense to specialize it.
>
> This is TERRIBLE since I think that I'm a good programmer but seaside
> code prevents me to
> be fully efficient. I have to guess try and error and guess again. I
> have to ask stupid questions to the mailing-list
> while I would prefer to use it for  interesting questions. I think
> that seaside goes even against the philosophy of
> Smalltalk (a system that someone alone can understand) because this
> total lacks of
> comments is TRAPPING me. I cannot use my skills full speed. Thanks
> what a great feeling.
> pleaseeeeeee do not tell me to read the code or to use senders! This
> is really the worse answer I can get.
> I always hated this kind of answer on smalltalk forums.
>
> (Please do not ask me what I'm doing to improve the situation because
> people knows what I did
> for seaside and Smalltalk already.)
>
> I think that as a community we should do something especially since we
> have monticello
> and comments could be easily merged.
>
> I pushed a lot seaside and I'm trying to push it again further but
> come on we should WAKE UP!
> I would really like that people with knowledge helps improving the
> situation.
>
> So if you think that seaside is cool and it is worth more, spend 30
> min of your precious time and
> add comments, help lukas and the other to make Seaside really a
> habitable piece of code.
>
> Comments are for people that do not know or remember. So if you really
> want to make the community
> grow you know what you should do. But may be it is better that seaside
> stays a cool program for a nice and
> private club after all.
>
> Stef
>
> PS: I should say that filelibrary is a good start at documenting a
> functionality. May be adding method comments
> would help there too.
>
> _______________________________________________
> Seaside mailing list
> [hidden email]
> http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
>
>
> __________ Information NOD32 2156 (20070330) __________
>
> Ce message a ete verifie par NOD32 Antivirus System.
> http://www.nod32.com
>
>
>


_______________________________________________
Seaside mailing list
[hidden email]
http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
Reply | Threaded
Open this post in threaded view
|

Re: Why seaside really sucks! COMMMMMMMENTS are MISSING

tblanchard
In reply to this post by stephane ducasse
So what are the mechanics of submitting comments?

On Apr 5, 2007, at 1:31 PM, stephane ducasse wrote:

> This is not easy for me to say that because I appreciate the work  
> of Avi, Lukas and Philippe.
> But I'm sorry to say that but seaside sucks! Not because of the  
> code or the concepts.
> But because there is really not enough comments. Really! It is  
> really difficult to understand a simple
> method is doing and if it makes sense to specialize it.
>
> This is TERRIBLE since I think that I'm a good programmer but  
> seaside code prevents me to
> be fully efficient. I have to guess try and error and guess again.  
> I have to ask stupid questions to the mailing-list
> while I would prefer to use it for  interesting questions. I think  
> that seaside goes even against the philosophy of
> Smalltalk (a system that someone alone can understand) because this  
> total lacks of
> comments is TRAPPING me. I cannot use my skills full speed. Thanks  
> what a great feeling.
> pleaseeeeeee do not tell me to read the code or to use senders!  
> This is really the worse answer I can get.
> I always hated this kind of answer on smalltalk forums.
>
> (Please do not ask me what I'm doing to improve the situation  
> because people knows what I did
> for seaside and Smalltalk already.)
>
> I think that as a community we should do something especially since  
> we have monticello
> and comments could be easily merged.
>
> I pushed a lot seaside and I'm trying to push it again further but  
> come on we should WAKE UP!
> I would really like that people with knowledge helps improving the  
> situation.
>
> So if you think that seaside is cool and it is worth more, spend 30  
> min of your precious time and
> add comments, help lukas and the other to make Seaside really a  
> habitable piece of code.
>
> Comments are for people that do not know or remember. So if you  
> really want to make the community
> grow you know what you should do. But may be it is better that  
> seaside stays a cool program for a nice and
> private club after all.
>
> Stef
>
> PS: I should say that filelibrary is a good start at documenting a  
> functionality. May be adding method comments
> would help there too.
>
> _______________________________________________
> Seaside mailing list
> [hidden email]
> http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside

_______________________________________________
Seaside mailing list
[hidden email]
http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
Reply | Threaded
Open this post in threaded view
|

Re: Why seaside really sucks! COMMMMMMMENTS are MISSING

Philippe Marschall
Commit them, they will get reviewed and if accepted merged.

2007/4/6, Todd Blanchard <[hidden email]>:

> So what are the mechanics of submitting comments?
>
> On Apr 5, 2007, at 1:31 PM, stephane ducasse wrote:
>
> > This is not easy for me to say that because I appreciate the work
> > of Avi, Lukas and Philippe.
> > But I'm sorry to say that but seaside sucks! Not because of the
> > code or the concepts.
> > But because there is really not enough comments. Really! It is
> > really difficult to understand a simple
> > method is doing and if it makes sense to specialize it.
> >
> > This is TERRIBLE since I think that I'm a good programmer but
> > seaside code prevents me to
> > be fully efficient. I have to guess try and error and guess again.
> > I have to ask stupid questions to the mailing-list
> > while I would prefer to use it for  interesting questions. I think
> > that seaside goes even against the philosophy of
> > Smalltalk (a system that someone alone can understand) because this
> > total lacks of
> > comments is TRAPPING me. I cannot use my skills full speed. Thanks
> > what a great feeling.
> > pleaseeeeeee do not tell me to read the code or to use senders!
> > This is really the worse answer I can get.
> > I always hated this kind of answer on smalltalk forums.
> >
> > (Please do not ask me what I'm doing to improve the situation
> > because people knows what I did
> > for seaside and Smalltalk already.)
> >
> > I think that as a community we should do something especially since
> > we have monticello
> > and comments could be easily merged.
> >
> > I pushed a lot seaside and I'm trying to push it again further but
> > come on we should WAKE UP!
> > I would really like that people with knowledge helps improving the
> > situation.
> >
> > So if you think that seaside is cool and it is worth more, spend 30
> > min of your precious time and
> > add comments, help lukas and the other to make Seaside really a
> > habitable piece of code.
> >
> > Comments are for people that do not know or remember. So if you
> > really want to make the community
> > grow you know what you should do. But may be it is better that
> > seaside stays a cool program for a nice and
> > private club after all.
> >
> > Stef
> >
> > PS: I should say that filelibrary is a good start at documenting a
> > functionality. May be adding method comments
> > would help there too.
> >
> > _______________________________________________
> > Seaside mailing list
> > [hidden email]
> > http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
>
> _______________________________________________
> Seaside mailing list
> [hidden email]
> http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
>
_______________________________________________
Seaside mailing list
[hidden email]
http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
Reply | Threaded
Open this post in threaded view
|

Re: Why seaside really sucks! COMMMMMMMENTS are MISSING

Brad Fuller
In reply to this post by stephane ducasse
Amen, brother.

stephane ducasse wrote:

> This is not easy for me to say that because I appreciate the work of
> Avi, Lukas and Philippe.
> But I'm sorry to say that but seaside sucks! Not because of the code
> or the concepts.
> But because there is really not enough comments. Really! It is really
> difficult to understand a simple
> method is doing and if it makes sense to specialize it.
>
> This is TERRIBLE since I think that I'm a good programmer but seaside
> code prevents me to
> be fully efficient. I have to guess try and error and guess again. I
> have to ask stupid questions to the mailing-list
> while I would prefer to use it for  interesting questions. I think
> that seaside goes even against the philosophy of
> Smalltalk (a system that someone alone can understand) because this
> total lacks of
> comments is TRAPPING me. I cannot use my skills full speed. Thanks
> what a great feeling.
> pleaseeeeeee do not tell me to read the code or to use senders! This
> is really the worse answer I can get.
> I always hated this kind of answer on smalltalk forums.
>
> (Please do not ask me what I'm doing to improve the situation because
> people knows what I did
> for seaside and Smalltalk already.)
>
> I think that as a community we should do something especially since we
> have monticello
> and comments could be easily merged.
>
> I pushed a lot seaside and I'm trying to push it again further but
> come on we should WAKE UP!
> I would really like that people with knowledge helps improving the
> situation.
>
> So if you think that seaside is cool and it is worth more, spend 30
> min of your precious time and
> add comments, help lukas and the other to make Seaside really a
> habitable piece of code.
>
> Comments are for people that do not know or remember. So if you really
> want to make the community
> grow you know what you should do. But may be it is better that seaside
> stays a cool program for a nice and
> private club after all.
>
> Stef
>
> PS: I should say that filelibrary is a good start at documenting a
> functionality. May be adding method comments
> would help there too.
>
> _______________________________________________
> Seaside mailing list
> [hidden email]
> http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
>


--
brad fuller
 http://www.Sonaural.com/
 +1 (408) 799-6124



_______________________________________________
Seaside mailing list
[hidden email]
http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
Reply | Threaded
Open this post in threaded view
|

Re: Why seaside really sucks! COMMMMMMMENTS are MISSING

Carl Gundel
In reply to this post by stephane ducasse
> This is not easy for me to say that because I appreciate the work of  Avi,
> Lukas and Philippe.
> But I'm sorry to say that but seaside sucks! Not because of the code  or
> the concepts.
> But because there is really not enough comments. Really! It is really
> difficult to understand a simple
> method is doing and if it makes sense to specialize it.

I also don't want to take for granted all the hard work that goes into
Seaside.  We have managed to leverage it pretty well with Run BASIC, but
there is a sense of frustration that we have not really tapped into what it
can do.  This is especially true when it comes to SeasideAsync and
Scriptaculous.  Better comments would probably go a long way.

In any case thanks for Seaside.  I love it!

-Carl Gundel
http://www.runbasic.com 


_______________________________________________
Seaside mailing list
[hidden email]
http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
Reply | Threaded
Open this post in threaded view
|

RE: Why seaside really sucks! COMMMMMMMENTS are MISSING

Sebastian Sastre-2
In reply to this post by stephane ducasse
Steph you're right but could be good that you also explain that beside a
Seaside dyagnosys is a dyagnosys for symptoms of unfriendly "uneducative"
anti-pattern not uncommon in our community.
I think we have responsibility to "work" this by helping to introduce
alternatives to those anti-patterns(*) and "best educative practices in
Smalltalk" and the related "profilaxy of the uneducative anti-patterns in
Smalltalk" for us all and not only on Seaside.

I love criticism is a very healthy thing. A tool for real progress. But one
must focus on efforts and results.

So Seaside's results don't suck. Documentation (the lak of it) does. All
un-human cryptic codification sucks. Smalltalk has a really great, great
chance to prevent that.

I imagine that your intention "behind the scenes" is this and you want to
take some attention with your comments. Is a valid thecnique of creating
some apparently controversial subject to awake people. I agree with you in
that.

And because of that it's also a chance to give two minutes of reflection
about the value of seeing the code one make and uses as a chance of
educating perhaps anonymously someone who will read that piece of software
somwhere in time. Smalltalk has pieces of code that remains for years.
Others technologies are a lot more volatile than that.

And as I see is not just "to comment" is to undestand that one can use the
comment as an oportunity to donate glimpses of your experience doing it. An
oportunity to express it in the most didactic way you can archieve at that
moment of glimpse you managed to build up and in which you have apprehension
of something. You have created an "apprehension field".

I you leave a mark of that apprehension field you are assisting someone to
reproduce that field and perhaps helping to archieve it's own apprehension.
That will save him/her time, misunderstandings, misleadings and for the same
price, in case you forget a detail, it can save it to yourself in the future
too.

That unegoistical attitude would be of precious value. Is not utopic is
practical and archivable. Often some self-criticism. That could be reflected
on the prosperity of the system you are working on. The price? 15 seconds
for method and some typing and redacting? That is an investiment that will
return to you in the form of more people understanding what you do and how
it works. People that could surpass learning smalltalk frustrations and will
reach a point in which they'll start to give it's part adding strenght to
our community that you will surely need to consult in subjects not familiar
to you.

I wanted to express that I think that the key to the change we need is to
adopt thecniques which pruposes sistematical donation of didactic clues
about the apprehension moments we experiment using Smalltalk.

That is what one could call programing for persons and not computers and in
my modest opinion one of the most valuable and subtle things that the spirit
of Smalltalk has to offer.

Regards,

Sebastian Sastre

(*) I want to put emphasys in all the anti-patterns that are not related to
programming (see: http://en.wikipedia.org/wiki/Anti-pattern) But more than
the basic reference I'm giving here, I want to put emphasys in the concept
of our community's own creative anti-patterns.
 

> -----Mensaje original-----
> De: [hidden email]
> [mailto:[hidden email]] En nombre
> de stephane ducasse
> Enviado el: Jueves, 05 de Abril de 2007 17:32
> Para: Seaside - general discussion
> Asunto: [Seaside] Why seaside really sucks! COMMMMMMMENTS are MISSING
>
> This is not easy for me to say that because I appreciate the
> work of Avi, Lukas and Philippe.
> But I'm sorry to say that but seaside sucks! Not because of
> the code or the concepts.
> But because there is really not enough comments. Really! It
> is really difficult to understand a simple method is doing
> and if it makes sense to specialize it.
>
> This is TERRIBLE since I think that I'm a good programmer but
> seaside code prevents me to be fully efficient. I have to
> guess try and error and guess again. I have to ask stupid
> questions to the mailing-list while I would prefer to use it
> for  interesting questions. I think that seaside goes even
> against the philosophy of Smalltalk (a system that someone
> alone can understand) because this total lacks of comments is
> TRAPPING me. I cannot use my skills full speed. Thanks what a
> great feeling.
> pleaseeeeeee do not tell me to read the code or to use
> senders! This is really the worse answer I can get.
> I always hated this kind of answer on smalltalk forums.
>
> (Please do not ask me what I'm doing to improve the situation
> because people knows what I did for seaside and Smalltalk already.)
>
> I think that as a community we should do something especially
> since we have monticello and comments could be easily merged.
>
> I pushed a lot seaside and I'm trying to push it again
> further but come on we should WAKE UP!
> I would really like that people with knowledge helps
> improving the situation.
>
> So if you think that seaside is cool and it is worth more,
> spend 30 min of your precious time and add comments, help
> lukas and the other to make Seaside really a habitable piece of code.
>
> Comments are for people that do not know or remember. So if
> you really want to make the community grow you know what you
> should do. But may be it is better that seaside stays a cool
> program for a nice and private club after all.
>
> Stef
>
> PS: I should say that filelibrary is a good start at
> documenting a functionality. May be adding method comments
> would help there too.
>
> _______________________________________________
> Seaside mailing list
> [hidden email]
> http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside

_______________________________________________
Seaside mailing list
[hidden email]
http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
Reply | Threaded
Open this post in threaded view
|

Re: Why seaside really sucks! COMMMMMMMENTS are MISSING

Rick Flower
In reply to this post by Philippe Marschall
Philippe Marschall wrote:
> Commit them, they will get reviewed and if accepted merged.
Can I assume that this must be done in the squeak environment and that
it might be extra work
to do this if you're using VW or other non-squeak dialects of ST -- correct?

Too bad VW can't talk directly to the Squeak repository too..

_______________________________________________
Seaside mailing list
[hidden email]
http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
Reply | Threaded
Open this post in threaded view
|

Re: Why seaside really sucks! COMMMMMMMENTS are MISSING

Philippe Marschall
2007/4/6, Rick Flower <[hidden email]>:
> Philippe Marschall wrote:
> > Commit them, they will get reviewed and if accepted merged.
> Can I assume that this must be done in the squeak environment and that
> it might be extra work
> to do this if you're using VW or other non-squeak dialects of ST -- correct?

Must is quite a strong word. I'm sure we would also accept change sets
posted to the mailing list or mantis.

Philippe

> Too bad VW can't talk directly to the Squeak repository too..
>
> _______________________________________________
> Seaside mailing list
> [hidden email]
> http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
>
_______________________________________________
Seaside mailing list
[hidden email]
http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
Reply | Threaded
Open this post in threaded view
|

Re: Why seaside really sucks! COMMMMMMMENTS are MISSING

Boris Popov, DeepCove Labs (SNN)
In reply to this post by stephane ducasse
Re: [Seaside] Why seaside really sucks! COMMMMMMMENTS are MISSING

Silly question, what is it you expect commented? Methods? Classes? Packages? Would we be better off with documentation instead? If I were looking for a way to configure select list with a labels block, where would I expect to find a comment for it? Look at every method in there until I see one with matching comment? No offence, just trying to see how I could help out, not once have I thought in the past year, jee I wish this was commented, because by the time you find what you're looking for, comment within it is a little late :)


Cheers!

-Boris
(Sent from a BlackBerry)

----- Original Message -----
From: [hidden email] <[hidden email]>
To: Seaside - general discussion <[hidden email]>
Sent: Fri Apr 06 11:53:47 2007
Subject: Re: [Seaside] Why seaside really sucks! COMMMMMMMENTS are MISSING

2007/4/6, Rick Flower <[hidden email]>:
> Philippe Marschall wrote:
> > Commit them, they will get reviewed and if accepted merged.
> Can I assume that this must be done in the squeak environment and that
> it might be extra work
> to do this if you're using VW or other non-squeak dialects of ST -- correct?

Must is quite a strong word. I'm sure we would also accept change sets
posted to the mailing list or mantis.

Philippe

> Too bad VW can't talk directly to the Squeak repository too..
>
> _______________________________________________
> Seaside mailing list
> [hidden email]
> http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
>
_______________________________________________
Seaside mailing list
[hidden email]
http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside


_______________________________________________
Seaside mailing list
[hidden email]
http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
Reply | Threaded
Open this post in threaded view
|

Re: Why seaside really sucks! COMMMMMMMENTS are MISSING

stephane ducasse
In reply to this post by Sebastian Sastre-2
I think that having a seaside app generating a simple doc out of  
Squeak class could help
people writing more comments and meaningful class comments.

The examples are already a good step in that directory but comments  
are missing.

Sorry if I did not get all what you said.

Stef


On 6 avr. 07, at 19:45, Sebastian Sastre wrote:

> Steph you're right but could be good that you also explain that  
> beside a
> Seaside dyagnosys is a dyagnosys for symptoms of unfriendly  
> "uneducative"
> anti-pattern not uncommon in our community.
> I think we have responsibility to "work" this by helping to introduce
> alternatives to those anti-patterns(*) and "best educative  
> practices in
> Smalltalk" and the related "profilaxy of the uneducative anti-
> patterns in
> Smalltalk" for us all and not only on Seaside.
>
> I love criticism is a very healthy thing. A tool for real progress.  
> But one
> must focus on efforts and results.
>
> So Seaside's results don't suck. Documentation (the lak of it)  
> does. All
> un-human cryptic codification sucks. Smalltalk has a really great,  
> great
> chance to prevent that.
>
> I imagine that your intention "behind the scenes" is this and you  
> want to
> take some attention with your comments. Is a valid thecnique of  
> creating
> some apparently controversial subject to awake people. I agree with  
> you in
> that.
>
> And because of that it's also a chance to give two minutes of  
> reflection
> about the value of seeing the code one make and uses as a chance of
> educating perhaps anonymously someone who will read that piece of  
> software
> somwhere in time. Smalltalk has pieces of code that remains for years.
> Others technologies are a lot more volatile than that.
>
> And as I see is not just "to comment" is to undestand that one can  
> use the
> comment as an oportunity to donate glimpses of your experience  
> doing it. An
> oportunity to express it in the most didactic way you can archieve  
> at that
> moment of glimpse you managed to build up and in which you have  
> apprehension
> of something. You have created an "apprehension field".
>
> I you leave a mark of that apprehension field you are assisting  
> someone to
> reproduce that field and perhaps helping to archieve it's own  
> apprehension.
> That will save him/her time, misunderstandings, misleadings and for  
> the same
> price, in case you forget a detail, it can save it to yourself in  
> the future
> too.
>
> That unegoistical attitude would be of precious value. Is not  
> utopic is
> practical and archivable. Often some self-criticism. That could be  
> reflected
> on the prosperity of the system you are working on. The price? 15  
> seconds
> for method and some typing and redacting? That is an investiment  
> that will
> return to you in the form of more people understanding what you do  
> and how
> it works. People that could surpass learning smalltalk frustrations  
> and will
> reach a point in which they'll start to give it's part adding  
> strenght to
> our community that you will surely need to consult in subjects not  
> familiar
> to you.
>
> I wanted to express that I think that the key to the change we need  
> is to
> adopt thecniques which pruposes sistematical donation of didactic  
> clues
> about the apprehension moments we experiment using Smalltalk.
>
> That is what one could call programing for persons and not  
> computers and in
> my modest opinion one of the most valuable and subtle things that  
> the spirit
> of Smalltalk has to offer.
>
> Regards,
>
> Sebastian Sastre
>
> (*) I want to put emphasys in all the anti-patterns that are not  
> related to
> programming (see: http://en.wikipedia.org/wiki/Anti-pattern) But  
> more than
> the basic reference I'm giving here, I want to put emphasys in the  
> concept
> of our community's own creative anti-patterns.
>
>
>> -----Mensaje original-----
>> De: [hidden email]
>> [mailto:[hidden email]] En nombre
>> de stephane ducasse
>> Enviado el: Jueves, 05 de Abril de 2007 17:32
>> Para: Seaside - general discussion
>> Asunto: [Seaside] Why seaside really sucks! COMMMMMMMENTS are MISSING
>>
>> This is not easy for me to say that because I appreciate the
>> work of Avi, Lukas and Philippe.
>> But I'm sorry to say that but seaside sucks! Not because of
>> the code or the concepts.
>> But because there is really not enough comments. Really! It
>> is really difficult to understand a simple method is doing
>> and if it makes sense to specialize it.
>>
>> This is TERRIBLE since I think that I'm a good programmer but
>> seaside code prevents me to be fully efficient. I have to
>> guess try and error and guess again. I have to ask stupid
>> questions to the mailing-list while I would prefer to use it
>> for  interesting questions. I think that seaside goes even
>> against the philosophy of Smalltalk (a system that someone
>> alone can understand) because this total lacks of comments is
>> TRAPPING me. I cannot use my skills full speed. Thanks what a
>> great feeling.
>> pleaseeeeeee do not tell me to read the code or to use
>> senders! This is really the worse answer I can get.
>> I always hated this kind of answer on smalltalk forums.
>>
>> (Please do not ask me what I'm doing to improve the situation
>> because people knows what I did for seaside and Smalltalk already.)
>>
>> I think that as a community we should do something especially
>> since we have monticello and comments could be easily merged.
>>
>> I pushed a lot seaside and I'm trying to push it again
>> further but come on we should WAKE UP!
>> I would really like that people with knowledge helps
>> improving the situation.
>>
>> So if you think that seaside is cool and it is worth more,
>> spend 30 min of your precious time and add comments, help
>> lukas and the other to make Seaside really a habitable piece of code.
>>
>> Comments are for people that do not know or remember. So if
>> you really want to make the community grow you know what you
>> should do. But may be it is better that seaside stays a cool
>> program for a nice and private club after all.
>>
>> Stef
>>
>> PS: I should say that filelibrary is a good start at
>> documenting a functionality. May be adding method comments
>> would help there too.
>>
>> _______________________________________________
>> Seaside mailing list
>> [hidden email]
>> http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
>
> _______________________________________________
> Seaside mailing list
> [hidden email]
> http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
>

_______________________________________________
Seaside mailing list
[hidden email]
http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
Reply | Threaded
Open this post in threaded view
|

Re: Why seaside really sucks! COMMMMMMMENTS are MISSING

stephane ducasse
In reply to this post by Boris Popov, DeepCove Labs (SNN)

On 6 avr. 07, at 21:01, Boris Popov wrote:

> Silly question, what is it you expect commented? Methods?
"I'm a cool method that does that and that my subclasses should  
redefine"...

"I'm private method doing that. But please do not override me instead  
specialize...."

> Classes?
for each class (important)
I want to have
        my goal
        my responsibility
        my collaborators
        my extensions hook
       
        may be link to examples
        Personally I do not care about my iv is a String.

> Packages? Would we be better off with documentation instead?
May be also at the package level.

> If I were looking for a way to configure select list with a labels  
> block, where would I expect to find a comment for it?

In a brush class comments and in the examples on the class side.
> Look at every method in there until I see one with matching  
> comment? No offence, just trying to see how I could help out, not  
> once have I thought in the past year, jee I wish this was  
> commented, because by the time you find what you're looking for,  
> comment within it is a little late :)

but commenting is not for people knowing :)

Stef

>
>
> Cheers!
>
> -Boris
> (Sent from a BlackBerry)
>
> ----- Original Message -----
> From: [hidden email] <seaside-
> [hidden email]>
> To: Seaside - general discussion <[hidden email]>
> Sent: Fri Apr 06 11:53:47 2007
> Subject: Re: [Seaside] Why seaside really sucks! COMMMMMMMENTS are  
> MISSING
>
> 2007/4/6, Rick Flower <[hidden email]>:
> > Philippe Marschall wrote:
> > > Commit them, they will get reviewed and if accepted merged.
> > Can I assume that this must be done in the squeak environment and  
> that
> > it might be extra work
> > to do this if you're using VW or other non-squeak dialects of ST  
> -- correct?
>
> Must is quite a strong word. I'm sure we would also accept change sets
> posted to the mailing list or mantis.
>
> Philippe
>
> > Too bad VW can't talk directly to the Squeak repository too..
> >
> > _______________________________________________
> > Seaside mailing list
> > [hidden email]
> > http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
> >
> _______________________________________________
> Seaside mailing list
> [hidden email]
> http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
>
> _______________________________________________
> Seaside mailing list
> [hidden email]
> http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside

_______________________________________________
Seaside mailing list
[hidden email]
http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
Reply | Threaded
Open this post in threaded view
|

Re: Why seaside really sucks! COMMMMMMMENTS are MISSING

Lorenzo
In reply to this post by stephane ducasse
Hi Stephan,

I completelly agree with you !

I am available to any collaboration I could give

Lorenzo
----- Original Message -----
From: "stephane ducasse" <[hidden email]>
To: "Seaside - general discussion" <[hidden email]>
Sent: Thursday, April 05, 2007 10:31 PM
Subject: [Seaside] Why seaside really sucks! COMMMMMMMENTS are MISSING


> This is not easy for me to say that because I appreciate the work of  
> Avi, Lukas and Philippe.
> But I'm sorry to say that but seaside sucks! Not because of the code  
> or the concepts.
> But because there is really not enough comments. Really! It is really  
> difficult to understand a simple
> method is doing and if it makes sense to specialize it.
>
> This is TERRIBLE since I think that I'm a good programmer but seaside  
> code prevents me to
> be fully efficient. I have to guess try and error and guess again. I  
> have to ask stupid questions to the mailing-list
> while I would prefer to use it for  interesting questions. I think  
> that seaside goes even against the philosophy of
> Smalltalk (a system that someone alone can understand) because this  
> total lacks of
> comments is TRAPPING me. I cannot use my skills full speed. Thanks  
> what a great feeling.
> pleaseeeeeee do not tell me to read the code or to use senders! This  
> is really the worse answer I can get.
> I always hated this kind of answer on smalltalk forums.
>
> (Please do not ask me what I'm doing to improve the situation because  
> people knows what I did
> for seaside and Smalltalk already.)
>
> I think that as a community we should do something especially since  
> we have monticello
> and comments could be easily merged.
>
> I pushed a lot seaside and I'm trying to push it again further but  
> come on we should WAKE UP!
> I would really like that people with knowledge helps improving the  
> situation.
>
> So if you think that seaside is cool and it is worth more, spend 30  
> min of your precious time and
> add comments, help lukas and the other to make Seaside really a  
> habitable piece of code.
>
> Comments are for people that do not know or remember. So if you  
> really want to make the community
> grow you know what you should do. But may be it is better that  
> seaside stays a cool program for a nice and
> private club after all.
>
> Stef
>
> PS: I should say that filelibrary is a good start at documenting a  
> functionality. May be adding method comments
> would help there too.
>
> _______________________________________________
> Seaside mailing list
> [hidden email]
> http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
>
_______________________________________________
Seaside mailing list
[hidden email]
http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
Reply | Threaded
Open this post in threaded view
|

Re: Why seaside really sucks! COMMMMMMMENTS are MISSING

Giles Bowkett
Seaside doesn't suck, but I'd definitely be happier if it were more
extensively documented. It's really good for a technology when the
beginning part of the learning curve is very easy.

--
Giles Bowkett
http://www.gilesgoatboy.org
http://gilesbowkett.blogspot.com
http://giles.tumblr.com/
_______________________________________________
Seaside mailing list
[hidden email]
http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
Reply | Threaded
Open this post in threaded view
|

Re: Why seaside really sucks! COMMMMMMMENTS are MISSING

Jason Johnson-3
In reply to this post by stephane ducasse
I'm surprised to be saying this, but one must not forget that commenting
also has a cost.  My current rule is that a comment shouldn't say what
something does.  If the code is so unclear that it would need such a
comment it should be rewritten (obviously if you're doing optimized code
this rule has to be relaxed a bit).  Comments should say what the code
doesn't (e.g. why was it done this way?  Are there some non-obvious
dependencies here?) [1].

And what is with the first person commenting?  For me it doesn't add
anything but typing/reading, with no value add.

"I am the method responsible for rendering the class..."

vs.

"responsible for rendering the class..."

Just my $ .02,
Jason

[1]  Of course the exception to this would be Javadoc style auto
generated documentation, but that stuff is generally just for presenting
the interface of a system and thus makes me wonder if the tests wouldn't
be a better source for it.

stephane ducasse wrote:

>
> On 6 avr. 07, at 21:01, Boris Popov wrote:
>
>> Silly question, what is it you expect commented? Methods?
> "I'm a cool method that does that and that my subclasses should
> redefine"...
>
> "I'm private method doing that. But please do not override me instead
> specialize...."
>
>> Classes?
> for each class (important)
> I want to have
>     my goal
>     my responsibility
>     my collaborators
>     my extensions hook
>    
>     may be link to examples
>     Personally I do not care about my iv is a String.
>
>> Packages? Would we be better off with documentation instead?
> May be also at the package level.
>
>> If I were looking for a way to configure select list with a labels
>> block, where would I expect to find a comment for it?
>
> In a brush class comments and in the examples on the class side.
>> Look at every method in there until I see one with matching comment?
>> No offence, just trying to see how I could help out, not once have I
>> thought in the past year, jee I wish this was commented, because by
>> the time you find what you're looking for, comment within it is a
>> little late :)
>
> but commenting is not for people knowing :)
>
> Stef
>>
>>
>> Cheers!
>>
>> -Boris
>> (Sent from a BlackBerry)
>>
>> ----- Original Message -----
>> From: [hidden email]
>> <[hidden email]>
>> To: Seaside - general discussion <[hidden email]>
>> Sent: Fri Apr 06 11:53:47 2007
>> Subject: Re: [Seaside] Why seaside really sucks! COMMMMMMMENTS are
>> MISSING
>>
>> 2007/4/6, Rick Flower <[hidden email]>:
>> > Philippe Marschall wrote:
>> > > Commit them, they will get reviewed and if accepted merged.
>> > Can I assume that this must be done in the squeak environment and that
>> > it might be extra work
>> > to do this if you're using VW or other non-squeak dialects of ST --
>> correct?
>>
>> Must is quite a strong word. I'm sure we would also accept change sets
>> posted to the mailing list or mantis.
>>
>> Philippe
>>
>> > Too bad VW can't talk directly to the Squeak repository too..
>> >
>> > _______________________________________________
>> > Seaside mailing list
>> > [hidden email]
>> > http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
>> >
>> _______________________________________________
>> Seaside mailing list
>> [hidden email]
>> http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
>>
>> _______________________________________________
>> Seaside mailing list
>> [hidden email]
>> http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
>
> _______________________________________________
> Seaside mailing list
> [hidden email]
> http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
>

_______________________________________________
Seaside mailing list
[hidden email]
http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
Reply | Threaded
Open this post in threaded view
|

Re: Why seaside really sucks! COMMMMMMMENTS are MISSING

timrowledge

On 12-Apr-07, at 12:05 PM, Jason Johnson wrote:

>
> And what is with the first person commenting?  For me it doesn't  
> add anything but typing/reading, with no value add.
>
> "I am the method responsible for rendering the class..."
The tendency to first person comments stems from the anthropomorphic  
viewpoint of being inside an object.

tim
--
tim Rowledge; [hidden email]; http://www.rowledge.org/tim
Useful Latin Phrases:- Die dulci fruere = Have a nice day


_______________________________________________
Seaside mailing list
[hidden email]
http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
Reply | Threaded
Open this post in threaded view
|

Re: Why seaside really sucks! COMMMMMMMENTS are MISSING

Brad Fuller
In reply to this post by Jason Johnson-3
Jason Johnson wrote:
> I'm surprised to be saying this, but one must not forget that
> commenting also has a cost.

Absolutely, it's a pain to do, costs LOTS of time and agony. But, the
rewards for others down the line are greater if done well.

Pay it forward.

> My current rule is that a comment shouldn't say what something does.  
> If the code is so unclear that it would need such a comment it should
> be rewritten

The value of comments, for me, is in the architecture description, the
concepts of the code and how to use it efficiently - more from a macro
view than a micro view. That's what I would like to see more of. I don't
necessarily care if the author explains what he does at the method level
unless it's crucial to understanding the usage and concepts of the
application. I want to understand from the author the architectural
design, the plumbing and how to use what he gave us.  From this
perspective, I think it would make it easier for authors to comment.
They don't have to comment every little method, and they get to show off
their pride and joy by describing (in detail!) their baby.


> (obviously if you're doing optimized code this rule has to be relaxed
> a bit).  Comments should say what the code doesn't (e.g. why was it
> done this way?  Are there some non-obvious dependencies here?) [1].
>
> And what is with the first person commenting?  For me it doesn't add
> anything but typing/reading, with no value add.
>
> "I am the method responsible for rendering the class..."
>
> vs.
>
> "responsible for rendering the class..."
+1. Except if the code actually wrote the comment itself ;-)


_______________________________________________
Seaside mailing list
[hidden email]
http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
Reply | Threaded
Open this post in threaded view
|

Re: Why seaside really sucks! COMMMMMMMENTS are MISSING

Jason Johnson-3
Brad Fuller wrote:
> Jason Johnson wrote:
>> I'm surprised to be saying this, but one must not forget that
>> commenting also has a cost.
>
> Absolutely, it's a pain to do, costs LOTS of time and agony. But, the
> rewards for others down the line are greater if done well.
>
> Pay it forward.

Ok, I obviously wasn't clear here.  I'm not complaining about commenting
my code.  I have actually read code where the comment about "what the
following method does" was longer then the actual code to do the work.

If I see a comment I expect it has something I need to know and therefor
read it.  This is extra work, so it needs to pay.  If I read someone's
code and the first 10 comments are just duplication of what the code is
clearly doing then I am less likely to read the rest, some of which are
bound to have something I *do* need to know.  This is the cost I was
talking about.
_______________________________________________
Seaside mailing list
[hidden email]
http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
Reply | Threaded
Open this post in threaded view
|

Re: Why seaside really sucks! COMMMMMMMENTS are MISSING

Jason Johnson-3
In reply to this post by timrowledge
Yea, I figured it had to do with "live objects" and everything.  I just
find it a bit distracting (like as in, when you go to the theater and
they put in about 3 more previews then normal before your movie), but
it's not a big deal.

tim Rowledge wrote:

>
> On 12-Apr-07, at 12:05 PM, Jason Johnson wrote:
>
>>
>> And what is with the first person commenting?  For me it doesn't add
>> anything but typing/reading, with no value add.
>>
>> "I am the method responsible for rendering the class..."
> The tendency to first person comments stems from the anthropomorphic
> viewpoint of being inside an object.
>
> tim
> --
> tim Rowledge; [hidden email]; http://www.rowledge.org/tim
> Useful Latin Phrases:- Die dulci fruere = Have a nice day
>
>
> _______________________________________________
> Seaside mailing list
> [hidden email]
> http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
>

_______________________________________________
Seaside mailing list
[hidden email]
http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
Reply | Threaded
Open this post in threaded view
|

RE: Why seaside really sucks! COMMMMMMMENTS are MISSING

Sebastian Sastre-2
In reply to this post by Jason Johnson-3
> > Pay it forward.
>
> Ok, I obviously wasn't clear here.  I'm not complaining about
> commenting my code.  I have actually read code where the
> comment about "what the following method does" was longer
> then the actual code to do the work.
>
An usual metric in Smalltalk used to be 1:5 for code comment lines.

> If I see a comment I expect it has something I need to know
> and therefor read it.  This is extra work, so it needs to
> pay.  If I read someone's code and the first 10 comments are
> just duplication of what the code is clearly doing then I am
> less likely to read the rest, some of which are bound to have
> something I *do* need to know.  This is the cost I was talking about.
> _______________________________________________

In that way you can't avoid to propose that newbies pay the price. I not
convinced about being clever to force that criteria to be valid for
everbody. You are thinking in the economy of a somehow experienced developer
(presumably your case) but what about the economy of newbies? They should be
forced to pay the price? Are you aware that that price are working as a
barrier to enter to the Smalltalk market?
I think more options (to access information) shuld be given for newbies
because of it's inexperience. Options that the experienced ones can prune
easily and in a rasonably cheap way using it's own discern.

Regards,

Sebastian

_______________________________________________
Seaside mailing list
[hidden email]
http://lists.squeakfoundation.org/cgi-bin/mailman/listinfo/seaside
12