- Pharo-dev - lists.pharo.org

Re: [Pharo-project] new template for class empty comments for OB

by Alexandre Bergel

Hi! I worked on a small prototype to help me write code documentation. As an example, here is a template that is automatically given for MOShape, an abstract class in Mondrian that does not have any class variables. MOShape has just one instance variable, isCached. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 'MOShape is PLEASE FILL MOShape is an abstract class. The following methods needs to be implemented #absoluteBoundsFor: #containsPoint:for: #display:on: #heightFor: #widthFor: Class collaborations MOFilledShape MORoundedRectangleShape MOEvent MOLineShape MOAbstractLineLayout MOHorizontalLineLayout MOShape MOVerticalLineLayout MONode MOMouseEvent MOFormsShape MOImageShape MOEasel MOViewRenderer MOShapeAdaptor MOGraphElement MOFormsBuilder MOBoundedShape MOChildrenShape MONodeShape Testing classes MOViewRendererTest MondrianTest MOFormsBuilderTest MONewFormsBuilderTest Class public API #absoluteBoundsFor: #apply:bounds: #boundsFor: #canHandleChildren #collectAllShapes #computeBoundsFor: #computeExtentFor: #containsPoint:for: #disableCache #display:on: #enableCache #heightFor: #isCached #isChildShape #isFormsShape #isLineShape #isNodeShape #isShape #scaleElement:by: Implementation notes Instance Variables: isCached -- PLEASE FILL Comments written by AlexandreBergel on 25 April 2011 ' -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= I plan to use this template for each class of Mondrian. The template can be easily automatically processed to detect inconsistency. A collaboration class is a class for which I sent to or received a message from. Unit tests are excluded. A public method is a method that is invoked by an instance of a different class. This is very Java specific, I know. We could scope it to an object instead of a class. What is your opinion on this template? Cheers, Alexandre On 25 Apr 2011, at 11:59, Alexandre Bergel wrote: > I see your point. We need to iterate on what a good template can be. > > In general, I believe a lot can be extracted from unit test execution that can serve as a good basis for documentation: public, private methods, collaboration, ... > > Alexandre > > > On 25 Apr 2011, at 03:15, Lukas Renggli wrote: > >> Hi Alexandre, >> >>> But this is not incompatible. The IVs may still be listed, >>> the template can be adjusted for that >> >> Yes, this is true and the proposed change takes the IVs into account. >> The only problem is that I have to scroll to the bottom in 90% of the >> cases as the variables are a couple of pages below the template text. >> 90% of the time I am looking for information and then something like >> the variable types is at least useful, a two page template is only >> "useful" the few times I actually write a comment. >> >> Lukas >> >> -- >> Lukas Renggli >> www.lukas-renggli.ch >> > > -- > _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: > Alexandre Bergel http://www.bergel.eu > ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;. > > > > > -- _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: Alexandre Bergel http://www.bergel.eu ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.

April 25, 2011

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

by DougEdmunds

2cents about "what is a well-documented class?": Information about the state variables (instance variables): what goes in the slot, and what it's for. Good examples (the layout gets skewed doing copy/paste) in RxsPredicate Instance Variables: predicate <BlockClosure> A one-argument block. If it evaluates to the value defined by <negated> when it is passed a character, the predicate is considered to match. negation <BlockClosure> A one-argument block that is a negation of <predicate>. SMxMorph Structure: instance var Type Description bounds Rectangle A Rectangle indicating my position and a size that will enclose me. owner SMxMorph My parent SMxMorph, or nil for the top-level SMxMorph, which is a or nil world, typically a SMxPasteUpMorph. submorphs Array My child Morphs. fullBounds Rectangle A Rectangle minimally enclosing me and my submorphs. color Color My primary color. Subclasses can use this in different ways. extension SMxMorphExtension Allows extra properties to be stored without adding a or nil storage burden to all morphs. -- View this message in context: http://forum.world.st/What-is-a-well-documented-class-tp3470956p3474024.html Sent from the Pharo Smalltalk mailing list archive at Nabble.com.

April 25, 2011

Re: [Pharo-project] Memory profiling

by Adrian Lienhard

Hi Alex, I assume that your test run always creates the same number objects with the same size. Given that, there doesn't appear to be any reason why the amount of allocated memory for the given run should vary. So its rather the way you measure that makes the difference. I don't know how you get your profiles, but if you use the VM GC stats, they are global and hence other processes may influence the outcome. Incremental GC is triggered depending on allocation count. There's a r/w VM param to configure this. So iGC is rather a crude way to measure memory usage as it doesn't consider object size (and it is a global counter)... As a solution I suggest to take a look at my DTrace provider for the Squeak/Pharo VM [1]. It allows you to take statistics on questions like: how many instances of which size and of which class were created by which process in which methods? In the blog post I give an example that illustrates the use of DTrace for exactly such a question. HTH, Adrian [1] http://www.adrian-lienhard.ch/blog?dialog=smalltak-meets-dtrace On Apr 24, 2011, at 05:32 , Alexandre Bergel wrote: > Hi! > > I have been working on a memory profiler for Pharo. People who attended Smalltalks'10 may remember Mariano Coca's presentation. > > Unfortunately, I am not satisfied with what we can obtain from the execution of a piece of code in Pharo. The amount of memory consumed by a method _significantly varies_ across execution. I have the impression that memory consumption is a less stable metric than execution time. > > For example, I used this as a benchmark: > > -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= > 7 timesRepeat: [ > 5 timesRepeat: [ Smalltalk garbageCollect]. > MemoryProfiler > viewProfiling: [ > 20 timesRepeat: [| view | > 5 timesRepeat: [ Smalltalk garbageCollect]. > Object new. Object new. > 5 timesRepeat: [ Smalltalk garbageCollect]. > > view := MOViewRenderer new. > view nodes: (1 to: 5000). > view root applyLayout] ] > inPackagesMatching: 'Mondrian-*' > ] > -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= > It opens a simple visualization in Mondrian. I tried to clean as much as I can before executing the code with multiple garbage collect. > > This piece of code return 7 profiles. > In a profile I have for the method MOBoundedShape>>heightFor: : > Number of Young Allocated Bytes: 42,879,008 bytes > Number of Old Allocated Bytes: 6,000,660 bytes > Total Allocated Bytes: 48,879,668 bytes > Number of Increased Memory Bytes: 0 bytes > Number of Incremental GC's: 1,415 > Number of Full GC's: 0 > Number of Tenures of Surving Objects: 164 > > In another profile I have: > Number of Young Allocated Bytes: -7,857,156 bytes > Number of Old Allocated Bytes: 6,008,872 bytes > Total Allocated Bytes: -1,848,284 bytes > Number of Increased Memory Bytes: 0 bytes > Number of Incremental GC's: 1,373 > Number of Full GC's: 0 > Number of Tenures of Surving Objects: 165 > > In another: > Number of Young Allocated Bytes: -11,956,720 bytes > Number of Old Allocated Bytes: 5,315,216 bytes > Total Allocated Bytes: -6,641,504 bytes > Number of Increased Memory Bytes: 0 bytes > Number of Incremental GC's: 1,354 > Number of Full GC's: 0 > Number of Tenures of Surving Objects: 145 > > And another: > Number of Young Allocated Bytes: 59,132,472 bytes > Number of Old Allocated Bytes: 6,177,772 bytes > Total Allocated Bytes: 65,310,244 bytes > Number of Increased Memory Bytes: 0 bytes > Number of Incremental GC's: 1,361 > Number of Full GC's: 0 > Number of Tenures of Surving Objects: 167 > > The metric "Number of Young Allocated Bytes", "Number of Old Allocated Bytes", "Total Allocated Bytes" are highly unpredictable: i.e., two profiles are likely to be completely different. I am not sure why is this so. I use the standard Pharo1.2 One click, without additional parameter to the VM. Do you think that other platforms and languages behave the same? > > However, the positive point is that it seems that the amount of incremental GC and the number of tenured objects may play an important role in estimating the memory consumption. These metrics are much more stable. > What do you think on this? Does it make sense to say that more a method triggers incremental GC, more it consumes memory? > > What exactly triggers an incremental GC? > > Cheers, > Alexandre > -- > _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: > Alexandre Bergel http://www.bergel.eu > ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;. > > > > > >

April 25, 2011

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

by csrabak＠bol.com.br

The tool is a text editor ;-) If we agree on my suggestions, we can compose a set of guidelines to arrive at deliverables that comply with them. One tool could be a template and a checklist to help the writer of the documentation. -- Cesar Rabak Em 25/04/2011 14:59, Alexandre Bergel < alexandre.bergel(a)me.com > escreveu: Ok, but what would be a tool that help you write comment? This cannot be the system browser. Alexandre On 25 Apr 2011, at 12:37, csrabak(a)bol.com.br wrote: > I think a well documented class is a class which can be understood by reading its documentation without having to resort to anything else, be it running the test only to see something not obvious, reading the code to understand the working which the document fell short; and without having to assemble a mini encyclopedia of references in order to grasp the contents of the documentation. > > my 0.019999 > > -- > Cesar Rabak > -- _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: Alexandre Bergel http://www.bergel.eu ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.

April 25, 2011

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

by laurent laffont

On Mon, Apr 25, 2011 at 8:30 PM, Alexandre Bergel <alexandre.bergel(a)me.com>wrote: > > May be I can check this with my local developer group on Tuesday (we meet > from 12:30 -> 13h30. If you wake up early :) > > 13:30 in france is 8:30 in Chile. I usually arrive at 8:20 at work. So, we > meet on tomorrow? > Using IRC? > No problem. We can use skype. Laurent. > > Cheers, > Alexandre > > > Laurent > > > > We could then write new tests, make sure ProfStef works for Pharo 1.3 and > fix the bug found by Mariano. > > > > Cheers, > > Alexandre > > > > > > On 24 Apr 2011, at 12:33, laurent laffont wrote: > > > > > > > > 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? > > > > > > haha I won't be able to look at it until Tuesday. > > > > > > Laurent. > > > > > > > > > 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 > > > ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;. > > > > > > > > > > > > > > > > > > > > > > > > > -- > > _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: > > Alexandre Bergel http://www.bergel.eu > > ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;. > > > > > > > > > > > > > > > > -- > _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: > Alexandre Bergel http://www.bergel.eu > ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;. > > > > > > >

April 25, 2011

Re: [Pharo-project] Glamour theme

by Alexandre Bergel

>> Just wondering whether you have tried to remove the black border of each windows. > The border is not black, it is only slightly darker and it is basically there to distinguish overlapping windows from one another. Ah ok. >> I indeed like to not have it around button, scrollbar. Why not windows? > > You have a border around buttons, because you want to distinguish them from the background. But the button has a different color from the background. > The scrollbar does not have a border because you can already distinguish it against the white. yes >> I have the impression what the window color has to slightly change when not in foreground. > > This is a terrible mechanism that I cannot make to work consistently. At least not yet. In any case, you would probably still want a small border. I was just wondering. >> I like the theme, even if I am more rounded than squared :-) > > The main reason for the square look is that rounded borders look terrible. If this would change, I would definitely play with it :). Ok Thanks, Alexandre > > Cheers, > Doru > > >> Cheers, >> Alexandre >> -- >> _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: >> Alexandre Bergel http://www.bergel.eu >> ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;. >> >> >> >> >> >> > > -- > www.tudorgirba.com > > "Beauty is where we see it." > > > > -- _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: Alexandre Bergel http://www.bergel.eu ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.

April 25, 2011

Re: [Pharo-project] Better debugging...

by Alexandre Bergel

I read this some times ago. Thanks for the link. I am interested to see which kind of "query" we can formulate for an execution. Cheers, Alexandre On 25 Apr 2011, at 13:50, Mariano Martinez Peck wrote: > Alexandre: have you ever look to http://www.adrian-lienhard.ch/blog?dialog=smalltak-meets-dtrace ? > He has integrated DTrace into the SqueakVM. > http://en.wikipedia.org/wiki/DTrace > > Maybe it is of help... > > Cheers > > mariano > > On Mon, Apr 25, 2011 at 8:31 PM, Alexandre Bergel <alexandre.bergel(a)me.com> wrote: > > I understand. But no matter the UI / environment / frontend , you will need first the "backend" (call it as you want). > > Yeah, we need an implementation :-) > Your work is indeed important. I foresee nice discussions at esug. > > Cheers, > Alexandre > > > > > > > > > "What is the exact difference of execution if I slightly change a method?" > > > "If I call #foo it works, if I call #foo2 it does not work. Why? What are the objects that appears with #foo2 that do not appear with #foo?" > > > All these questions are essential in my opinion. > > > > > > > > > I agree. > > > > > > Code profiler and code debugger are pretty poor. I can continue with test code coverage tools. > > > After all, Computer Science is a pretty young science. > > > > > > Cheers, > > > Alexandre > > > > > > > > > > > > On 25 Apr 2011, at 07:34, Craig Latta wrote: > > > > > > > > > > > Hi Alexandre-- > > > > > > > >> Debugging, as well as profiling, is a topic that everybody got it > > > >> wrong. We still debug an application in oo in the same way that > > > >> people debugged their C program: thinking in term of call stack and > > > >> stack frame instead of objects. > > > > > > > > So tell us more! :) How do you express causality? > > > > > > > > > > > > -C > > > > > > > > -- > > > > Craig Latta > > > > www.netjam.org/resume > > > > +31 06 2757 7177 > > > > + 1 415 287 3547 > > > > > > > > > > > > > > > > > > > > > > -- > > > _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: > > > Alexandre Bergel http://www.bergel.eu > > > ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;. > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > -- > > > Mariano > > > http://marianopeck.wordpress.com > > > > > > > -- > > _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: > > Alexandre Bergel http://www.bergel.eu > > ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;. > > > > > > > > > > > > > > > > > > > > -- > > Mariano > > http://marianopeck.wordpress.com > > > > -- > _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: > Alexandre Bergel http://www.bergel.eu > ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;. > > > > > > > > > > -- > Mariano > http://marianopeck.wordpress.com > -- _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: Alexandre Bergel http://www.bergel.eu ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.

April 25, 2011

[Pharo-project] Suggestions: move examples from UIThemes class to ExampleBuilderMorph class

by DougEdmunds

A couple of suggestions Part 1. Move the methods in the UIThemes class, protocol 'examples' to ExampleBuilderMorph class, protocol 'examples'. Rationale: Every one of these examples first creates an instance of ExampleBuilderMorph as the base class that the example is built on. These examples do not demonstrate anything about how to use UITheme. I made a file that duplicates the methods from UITheme class -examples- to ExampleBuilderMorph class -examples-, suitable for filein. Methods such as ExampleBuilderMorph class >>exampleBasicControls work fine, indicating they have no dependence on UITheme. The file's 347 lines, so I'm not posting it here, unless requested. Part 2. Then move ExampleBuilderMorph and ExampleRadioButtonModel from Polymorph-Widgets into a new package called Polymorph-Widgets-Examples. Rationale: This would be reduce the size of Polymorph-Widgets, and make it more obvious that there are some examples of the widgets to look at. UITheme class is not the place where one expects to find examples of buttons, checkboxes, etc. Also this would be consistent with other Morphic packages. (Morphic-MorphTreeWidget and Morphic-MorphTreeWidget-Examples) --- -- View this message in context: http://forum.world.st/Suggestions-move-examples-from-UIThemes-class-to-Exam… Sent from the Pharo Smalltalk mailing list archive at Nabble.com.

April 25, 2011

[Pharo-project] Suggestion: rename some methods for consistency

by DougEdmunds

The vast majority of example methods follow a consistent naming pattern where the word 'example' starts the method name. There's a handful that don't. The advantage of this approach is that all the examples appear together in the browser list of methods. I suggest that these methods be renamed: BorderedMorph class >> gradientExample --> exampleGradient SimpleHierarchicalListMorph class >> submorphsExample --> exampleSubmorphs PluggableMenuSpec class >> withOneSingleItemExample --> exampleWithOneSingleItem PluggableMenuSpec class >> withSubMenuExample --> exampleWithSubMenu PluggableMenuSpec class >> withTwoSimpleItemsExample --> exampleWithTwoSimpleItems DigitalSignatureAlgorith >> writeExamplesToDisk --> exampleWriteToDisk UITheme class >> textEntryWithCompletionDialog --> exampletextEntryWithCompletionDialog UITheme class >> closeExampleDialogs --> exampleCloseDialogs (I've excluded test and testcase examples from this list). -- View this message in context: http://forum.world.st/Suggestion-rename-some-methods-for-consistency-tp3473… Sent from the Pharo Smalltalk mailing list archive at Nabble.com.

April 25, 2011

Re: [Pharo-project] Better debugging...

by Alexandre Bergel

> I understand. But no matter the UI / environment / frontend , you will need first the "backend" (call it as you want). Yeah, we need an implementation :-) Your work is indeed important. I foresee nice discussions at esug. Cheers, Alexandre > > > > > "What is the exact difference of execution if I slightly change a method?" > > "If I call #foo it works, if I call #foo2 it does not work. Why? What are the objects that appears with #foo2 that do not appear with #foo?" > > All these questions are essential in my opinion. > > > > > > I agree. > > > > Code profiler and code debugger are pretty poor. I can continue with test code coverage tools. > > After all, Computer Science is a pretty young science. > > > > Cheers, > > Alexandre > > > > > > > > On 25 Apr 2011, at 07:34, Craig Latta wrote: > > > > > > > > Hi Alexandre-- > > > > > >> Debugging, as well as profiling, is a topic that everybody got it > > >> wrong. We still debug an application in oo in the same way that > > >> people debugged their C program: thinking in term of call stack and > > >> stack frame instead of objects. > > > > > > So tell us more! :) How do you express causality? > > > > > > > > > -C > > > > > > -- > > > Craig Latta > > > www.netjam.org/resume > > > +31 06 2757 7177 > > > + 1 415 287 3547 > > > > > > > > > > > > > > > > -- > > _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: > > Alexandre Bergel http://www.bergel.eu > > ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;. > > > > > > > > > > > > > > > > > > > > -- > > Mariano > > http://marianopeck.wordpress.com > > > > -- > _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: > Alexandre Bergel http://www.bergel.eu > ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;. > > > > > > > > > > -- > Mariano > http://marianopeck.wordpress.com > -- _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: Alexandre Bergel http://www.bergel.eu ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.

April 25, 2011