April 2011 - Pharo-dev - lists.pharo.org

Re: [Pharo-project] What is a well documented class?

by StÃ©phane Ducasse

Alex give a try and see. I think that this is important. We can even publish something out of it :) Stef On Apr 24, 2011, at 6:17 PM, Alexandre Bergel wrote: >>> - each public method belongs to a method category named public* >>> - each private method belongs to a method category named private* >> >> Others here may disagree -- and the dreary of legislating and >> enforcing conventions aside -- but I strive (usually with success) to >> move all privately-used methods to one or more delegates. One class's >> private method is just another's public??? > > A private method may have to access instances variables. Moving the method to another class may be difficult sometimes. > >>> - other methods are considered as "package visible", meaning that they belong to a category that does not begins with 'private' or 'public' >> >> Again, I sympathise with facing the visibility problem, but I don't >> trust that conventions will be upheld by either end, so I tire of >> following them. Replace Pharo/Squeak categories with Newspeak >> modules; replace Pharo/Squeak protocols with traits (stateless, >> please); I'll be the first in line. > > I do not think this should be enforced. It is easy to infer method visibility with a set of well defined scenarios, for example the one that comes in unit tests. > > Cheers, > Alexandre > -- > _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: > Alexandre Bergel http://www.bergel.eu > ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;. > > > > > >

April 24, 2011

Re: [Pharo-project] Error with latest ProfStef in Pharo 1.3

by Mariano Martinez Peck

http://code.google.com/p/pharo/issues/detail?id=4086 On Sun, Apr 24, 2011 at 6:43 PM, Alexandre Bergel <alexandre.bergel(a)me.com>wrote: > ah ah! This is what we have changed during the pharo cast. > Laurent, do you want that we have a look at it together? > > Cheers, > Alexandre > > > On 24 Apr 2011, at 11:30, Mariano Martinez Peck wrote: > > > "Error 'Please use buildTutorialTopicFor: instead'" > > > > when I try to open it from the menu. > > > > ProfStefHelpTutorialBuilder >> buildHelpTopicFrom: aHelpTopicDescription > > "Start building from the given help topic description" > > > > ^(self new) > > rootToBuildFrom: aHelpTopicDescription; > > build; > > topicToBuild > > > > the rpoblem is that #new > > > > I am using last versions of Pharo1.3 > > > > -- > > Mariano > > http://marianopeck.wordpress.com > > > > -- > _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: > Alexandre Bergel http://www.bergel.eu > ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;. > > > > > > > -- Mariano http://marianopeck.wordpress.com

April 24, 2011

Re: [Pharo-project] What is a well documented class?

by StÃ©phane Ducasse

>>> >> May I ask, what if we stopped ever mentioning instance vars in the >> class comment? Perhaps it's a problem of having only one place to >> document both external and internal details of the class, but it >> really irks me when the comment template for a newly created class >> suggests that I divulge the implementation details in what appears to >> be a document of the interface. Moreover, the comment must change >> when the implementation changes, even if the interface remains the >> same. Perhaps that's why so many class comments seem out of sync with >> the current state of their classes. > > > Indeed. Synchronizing the documentation and the code is a problem. yes but.... let us write more comments. All the rest is arguments not to write them which is far easier as usual. Stef

April 24, 2011

Re: [Pharo-project] Henrik should we include Settings-Sound ?

by Mariano Martinez Peck

yes, but this package Setttings is only the integration with the Settings browser...that's why I think we should include it. cheers On Sun, Apr 24, 2011 at 5:42 PM, StÃ©phane Ducasse <stephane.ducasse(a)inria.fr > wrote: > I do not remember the situation with the sound. > I think that we should clean the soundService and the rest. > But right now I'm trying to move on the package but this is a huge pain. > > Stef > > > There is the repository http://www.squeaksource.com/PharoSound > > In that repo you will see a package "Settings-Sound" which is not > included in ConfigurationOfPharoSound nor in any other place. Hence, it is > not included in PharoDev. > > I am just wondering if we need to include such package or not. > > Henrik is the commiter of such packages so I asked. > > > > Cheers > > > > Mariano > > > > On Sun, Apr 24, 2011 at 4:53 PM, StÃ©phane Ducasse < > stephane.ducasse(a)inria.fr> wrote: > > btw can you provide more context? > > You mean that it is not manage as a configuration but is referenced in > pharo-dev conifguration ? > > > > On Apr 24, 2011, at 4:42 PM, Mariano Martinez Peck wrote: > > > > > no > > > > > > On Sun, Apr 24, 2011 at 4:36 PM, StÃ©phane Ducasse < > stephane.ducasse(a)inria.fr> wrote: > > > it is not? > > > > > > Stef > > > On Apr 24, 2011, at 3:57 PM, Mariano Martinez Peck wrote: > > > > > > > I saw that package in PharoSound and I wonder if it should be added > to the Metacello conf > > > > > > > > cheers > > > > > > > > > > > > -- > > > > Mariano > > > > http://marianopeck.wordpress.com > > > > > > > > > > > > > > > > > > > > > > -- > > > Mariano > > > http://marianopeck.wordpress.com > > > > > > > > > > > > > > > -- > > Mariano > > http://marianopeck.wordpress.com > > > > > -- Mariano http://marianopeck.wordpress.com

April 24, 2011

Re: [Pharo-project] What is a well documented class?

by StÃ©phane Ducasse

first let us start changing the default class comment template to have these sections. Stef On Apr 24, 2011, at 5:57 PM, Alexandre Bergel wrote: >> for the class comment I would have >> >> intention >> I'm doing that >> collaborations >> with the help of this class and that class >> main api >> my main public API is ... >> >> my subclasses may want to override such specific hooks ... >> >> Implementation notes >> iv and their purposes > > Yes! The collaborations and main api may be automatically inferred (from unit tests?) > The public interface can also be inferred. > I will work on this. > > Alexandre > > >> >> >>> Hi! >>> >>> I am dreaming about a tool to help me document source code. The question I have is what is a well documented class? >>> What do you think about the following: >>> >>> A well documented class is a class: >>> - that contains a class comment >>> - its class comments contains either an example, or an associated unit test >>> - without 'as yet unclassified' method category >>> - each public method belongs to a method category named public* >>> - each private method belongs to a method category named private* >>> - each method contains a comment, located before the declaration of temporary variables >>> - other methods are considered as "package visible", meaning that they belong to a category that does not begins with 'private' or 'public' >>> - without commented code contained in its methods. >>> >>> Is there anything else? >>> >>> Cheers, >>> Alexandre >>> -- >>> _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: >>> Alexandre Bergel http://www.bergel.eu >>> ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;. >>> >>> >>> >>> >>> >>> >> >> > > -- > _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: > Alexandre Bergel http://www.bergel.eu > ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;. > > > > > >

April 24, 2011

Re: [Pharo-project] Henrik should we include Settings-Sound ?

by StÃ©phane Ducasse

I do not remember the situation with the sound. I think that we should clean the soundService and the rest. But right now I'm trying to move on the package but this is a huge pain. Stef > There is the repository http://www.squeaksource.com/PharoSound > In that repo you will see a package "Settings-Sound" which is not included in ConfigurationOfPharoSound nor in any other place. Hence, it is not included in PharoDev. > I am just wondering if we need to include such package or not. > Henrik is the commiter of such packages so I asked. > > Cheers > > Mariano > > On Sun, Apr 24, 2011 at 4:53 PM, StÃ©phane Ducasse <stephane.ducasse(a)inria.fr> wrote: > btw can you provide more context? > You mean that it is not manage as a configuration but is referenced in pharo-dev conifguration ? > > On Apr 24, 2011, at 4:42 PM, Mariano Martinez Peck wrote: > > > no > > > > On Sun, Apr 24, 2011 at 4:36 PM, StÃ©phane Ducasse <stephane.ducasse(a)inria.fr> wrote: > > it is not? > > > > Stef > > On Apr 24, 2011, at 3:57 PM, Mariano Martinez Peck wrote: > > > > > I saw that package in PharoSound and I wonder if it should be added to the Metacello conf > > > > > > cheers > > > > > > > > > -- > > > Mariano > > > http://marianopeck.wordpress.com > > > > > > > > > > > > > > > -- > > Mariano > > http://marianopeck.wordpress.com > > > > > > > > -- > Mariano > http://marianopeck.wordpress.com >

April 24, 2011

[Pharo-project] Help updating confs and building Pharo 1.3

by Mariano Martinez Peck

Hi guys. During the last sprint and during this weekend I did a pass trying to update all Metacello configurations for Pharo 1.3. I have updated most of them. What I need is that people: - update all the confs that are not yet updated to work on Pharo 1.3 - test them - report if there are problems. We cannot wait the last minute for PharoDev, it has to be build and test now. Hudson cannot build right now because there is another problem, but you can test your packages/projects anyway. Cheers -- Mariano http://marianopeck.wordpress.com

April 24, 2011

Re: [Pharo-project] Error with latest ProfStef in Pharo 1.3

by Mariano Martinez Peck

Here is the PharoDebug.log On Sun, Apr 24, 2011 at 5:30 PM, Mariano Martinez Peck < marianopeck(a)gmail.com> wrote: > "Error 'Please use buildTutorialTopicFor: instead'" > > when I try to open it from the menu. > > ProfStefHelpTutorialBuilder >> buildHelpTopicFrom: aHelpTopicDescription > "Start building from the given help topic description" > > ^(self new) > rootToBuildFrom: aHelpTopicDescription; > build; > topicToBuild > > the rpoblem is that #new > > I am using last versions of Pharo1.3 > > -- > Mariano > http://marianopeck.wordpress.com > > -- Mariano http://marianopeck.wordpress.com

April 24, 2011

[Pharo-project] Error with latest ProfStef in Pharo 1.3

by Mariano Martinez Peck

"Error 'Please use buildTutorialTopicFor: instead'" when I try to open it from the menu. ProfStefHelpTutorialBuilder >> buildHelpTopicFrom: aHelpTopicDescription "Start building from the given help topic description" ^(self new) rootToBuildFrom: aHelpTopicDescription; build; topicToBuild the rpoblem is that #new I am using last versions of Pharo1.3 -- Mariano http://marianopeck.wordpress.com

April 24, 2011

Re: [Pharo-project] UndefinedObject(Object)>>doesNotUnderstand: #findNextHandlerContextStarting

by Mariano Martinez Peck

sorry I forgot to attach. On Sun, Apr 24, 2011 at 5:12 PM, Mariano Martinez Peck < marianopeck(a)gmail.com> wrote: > grrrr I don't know what is happening. I am building a PharoDev 1.3 and at > the end, I do: Undeclared removeUnreferencedKeys > but this throws an error that I attach. It is a big loop of such error. > The progress bar is showing "Clean up in DebuggerMethodMap" > > > In addition Undeclared ->>>> a Dictionary(#NoSuchElementError->nil ) > I checked http://code.google.com/p/pharo/issues/detail?id=4043 but there > is no such method. > > Now...if I execute Undeclared removeUnreferencedKeys again, it works. > > The bad news is that this prevents the PharoDev 1.3 to be build.... > > I have no clue of what can be happening, but the only way I found so far to > reproduce it is to: > > Gofer new > squeaksource: 'PharoTaskForces'; > pacakge: 'ConfigurationOfPharo'; > load. > > And then: > > (ConfigurationOfPharo project version: '1.3-beta') load > > > > -- > Mariano > http://marianopeck.wordpress.com > > -- Mariano http://marianopeck.wordpress.com

April 24, 2011