- Pharo-dev - lists.pharo.org

Re: [Pharo-dev] The importance of Class Comments

by stepharo

On 20/6/14 09:10, kilon alios wrote: > I completely understand the inability to create full blown > documentation because of lack of free time. I am not referring to any > Pharo Library out there. > Please pharo developers comment your classes. +10000000 > > Dont even comment the small ones, comment the big ones (over 20 > methods). 5 minutes per class , is 150 words (assuming you are a slow > 30 words/per minute , 3 times more if you type fast). Just a class > comment, I can live without method comments. 15 lines, enough to > provide valuable information to your users. > > Even for very big libraries like Spec it should not take more than 10 > key classes to be documented this way , no more than 1 hour total of > documentation for a project that can take months of coding to > complete. It can't be this hard. > > Saying that I will start adding class comments wherever I can but > obviously the people that have created the code are far more qualified > than me . > > Have a nice day :)

June 20, 2014

Re: [Pharo-dev] Pharo VM crash on seom DrGeo sketch

by Igor Stasenko

On 20 June 2014 08:45, stepharo <stepharo(a)free.fr> wrote: > Hilaire > > do you have the error stack? Because the vm crash does not help. > > well, the log file gives enough information what causing the problem. Most recent primitives primRenderScanline:with: primFinishedProcessing primRenderScanline:with: primFinishedProcessing primRenderScanline:with: it is balloon plugin.. which responsible for rendering complex shapes. looks like for some shapes/complexity it doesn't works well? or input is not well formed..? > Stef > > > On 19/6/14 18:25, Hilaire Fernandes wrote: > >> Hi, >> >> I have some VM crash on some DrGeo. It happens from the DrGeo file >> dialog when the preview of a sketch is computed. It is repeatable. >> >> I saw it on Mac, then in Linux as well. >> >> See below the log >> >> Hilaire >> >> >> > > -- Best regards, Igor Stasenko.

June 20, 2014

Adding progress to SmalllintChecker

by Yuriy Tymchuk

Hi, can we add the progress bar to RBSmalllintChecker so we will see how many classes have been already checked? Or also how many methods in the class (though I donât think this is reasonable). Uko

June 20, 2014

[pharo-project/pharo-core] 364f4b: 40026

by GitHub

Branch: refs/heads/4.0 Home: https://github.com/pharo-project/pharo-core Commit: 364f4b8d02889711941dcacbde2d7bd764f7a564 https://github.com/pharo-project/pharo-core/commit/364f4b8d02889711941dcacb… Author: Jenkins Build Server <board(a)pharo-project.org> Date: 2014-06-20 (Fri, 20 Jun 2014) Changed paths: M OpalCompiler-Core.package/SyntaxErrorNotification.class/README.md M OpalCompiler-Core.package/SyntaxErrorNotification.class/definition.st M OpalCompiler-Core.package/SyntaxErrorNotification.class/instance/accessing/errorMessage.st R OpalCompiler-Core.package/SyntaxErrorNotification.class/instance/accessing/messageText.st M OpalCompiler-Core.package/SyntaxErrorNotification.class/instance/accessing/setClass_category_code_doitFlag_errorMessage_location_.st M ProfStef-Core.package/PharoSyntaxTutorial.class/instance/interactive/prepareDebuggerExample.st A ScriptLoader40.package/ScriptLoader.class/instance/pharo - scripts/script26.st A ScriptLoader40.package/ScriptLoader.class/instance/pharo - updates/update40026.st M ScriptLoader40.package/ScriptLoader.class/instance/public/commentForCurrentUpdate.st Log Message: ----------- 40026 11987 Launching ProfStef should now require initials https://pharo.fogbugz.com/f/cases/11987 12579 SyntaxErrorNotification>>messageText https://pharo.fogbugz.com/f/cases/12579 http://files.pharo.org/image/40/40026.zip

June 20, 2014

[pharo-project/pharo-core]

by GitHub

Branch: refs/tags/40026 Home: https://github.com/pharo-project/pharo-core

June 20, 2014

Re: [Pharo-dev] How to convert properyl an Athens Surface to a Form

by Igor Stasenko

the best way is to blit surface on the morphic canvas using displayOnMorphicCanvas: canvas at: aPoint method. On 19 June 2014 22:16, Nicolai Hess <nicolaihess(a)web.de> wrote: > I use asForm and it works for me. > can you create a screenshot with the odd result > it creates. > > > > > > > > > 2014-06-19 21:58 GMT+02:00 Hilaire Fernandes <hilaire.fernandes(a)gmail.com> > : > > Hi, >> I can't find it. #asForm message produce odd result for me. >> >> Hilaire >> >> >> > -- Best regards, Igor Stasenko.

June 20, 2014

Re: [Pharo-dev] Athens and StrikeFont ( again )

by Igor Stasenko

On 20 June 2014 02:01, Alexandre Bergel <alexandre.bergel(a)me.com> wrote: > Times to times, font are displayed in a very weir fashion: small and big > letter. Width is not properly computed in addition. > > that should be fixed already.. i will check. > Alexandre > > > Le 19-06-2014 Ã 18:26, Nicolai Hess <nicolaihess(a)web.de> a Ã©crit : > > > > > > If I take a fresh pharo image I always have to reenable FT fonts before > > doing any athens rendering with text > > (RMOD StrikeFont(Object)>>doesNotUnderstand: #getPreciseHeight). > > > > Ok, I know I have to > > open settings > > disable then > > enable FreeType > > and choose a FreeType font. > > > > But what exactly is the problem with Athens rendering and non FT fonts? > > > > > > Nicolai > > -- Best regards, Igor Stasenko.

June 20, 2014

Re: [Pharo-dev] The importance of Class Comments

by Sven Van Caekenberghe

You are not targeting me, you are targeting everybody, that is why I, as a member of this community trying to improve things, feel offended. By saying 'the class comments are not good', you imply all of them. If I say 'people from country X are lazy' or even 'many/most of them are lazy', most people of that country, especially those who are definitively not will be rightfully offended. It is a generalisation that creates a bad reputation which is unfair. Of course you don't have to call out individual people, but if there are large packages out there (inside Pharo even) with 10s or 100s of classes with zero comments, then we as users have every right to say WTF !? And for me, those are terrible parts (with respects to documentation), because it is very hard to even start looking at the code and find your way. Spec _is_ partially documented - the website www.spec.org and the papers are pretty good - it took Ben and Johan lots of time and I appreciate that a lot. The problem of Spec is that it is a bit strange, hard to get your finger on (it is a UI specification, abstraction and composition layer, not a GUI toolkit as such). It confuses people (things are called model, but these are UI models, not domain models). Furthermore, it evolved a lot so that there are historic inconsistencies between current code, examples and documentation. But I know you are helping to improve Pharo, especially around documentation, so I am not angry at all - I know for a fact that the situation around documentation has been improving a lot, and improvements accelerated in the last year. On 20 Jun 2014, at 12:17, kilon alios <kilon.alios(a)gmail.com> wrote: > " It sounds a bit like there is no documentation at all" > > Î never implied this, and I refuse to believe that my wording can sound like that. I just say that the class comments are usually too small and many important classes are not documented at all. I don't know why you think I targeted you specifically with my comments. > > "terrible parts" is not the word I will use. I find the lack of documentation frustrating but that does not make the classes themselves "terrible". Pharo has its fair share of messy code but I have failed to see something I would call terrible. > > Its awesome that you spent large amount of time documenting, but all I said is that documenting key classes in the range of 10-15 lines each should not take a lot of time and pharo developers should do it. Thats my opinion, you are more than welcome to disagree or ignore it. > > I am willing to help any way I can. I am not willing to put blame on people. > > I do feel however because I believe I am a logical person that people that are introduced to Pharo will be disappointed in this department as I am. I think this is unfair to Pharo, because you guys have put a lot of effort in it that partly goes to waste. Imagine what would happen if people had easy access to the libraries , how many more would contribute and help pharo. > > I cannot imagine where I would be if there was no PBE or PFTE or the class comments that already are in there. For me any form of documentation is like bread and butter. > > Am I unreasonable ? > > I hope not. > > > > > On Fri, Jun 20, 2014 at 11:45 AM, Sven Van Caekenberghe <sven(a)stfx.eu> wrote: > I am a bit offended by the generalisations in your remarks, Kilon. It sounds a bit like there is no documentation at all. > > There are several books, covering many of the high level aspects. > > There is lots of documentation in the image, many class comments are pretty good, as are many method comments - even quite a lot of implementation comments can be found. > > OK, there are some terrible parts as well, and some people seems to make a sport out of _not_ writing any comments at all - please call them out specifically, but don't generalise. > > I have spent a large amount of time documenting all code that I published as well as writing separate high level documentation and tutorials for most of it as well as for Pharo in general. I know many others who did the same. > > On 20 Jun 2014, at 10:10, Yuriy Tymchuk <yuriy.tymchuk(a)me.com> wrote: > > > I have not worked with spec a lot, but I think that itâs nice in terms of comments, they are very helpful. Also lately Iâve worked with Roassal2 - no comments at all, but you can ask Alex for help :) > > > > Uko > > > > On 20 Jun 2014, at 10:06, kilon alios <kilon.alios(a)gmail.com> wrote: > > > >> yes good idea Damien , thank you. Right now I am working with Rubric building a new workspace tool basing it on the rubric example. Spec and Morphic are on my list too. > >> > >> Should I open also an issue on the bug tracker with a slice of my class comment ? Or is posting it here enough ? > >> > >> > >> On Fri, Jun 20, 2014 at 10:47 AM, Damien Cassou <damien.cassou(a)gmail.com> wrote: > >> > >> On Fri, Jun 20, 2014 at 9:10 AM, kilon alios <kilon.alios(a)gmail.com> wrote: > >> Saying that I will start adding class comments wherever I can but obviously the people that have created the code are far more qualified than me . > >> > >> > >> I suggest that you ask on this mailing list when you would like to have documentation on a class and you can't write it yourself. That way, we all will read the answer. Hopefully, someone, will merge this and write a class comment. > >> > >> > >> -- > >> Damien Cassou > >> http://damiencassou.seasidehosting.st > >> > >> "Success is the ability to go from one failure to another without losing enthusiasm." > >> Winston Churchill > >> > > > > >

June 20, 2014

Linking to online documentation

by kilon alios

Hello guys I want to create a small documentation tool that will display my own documentation for classes and methods and then have a more info button for linking to existing documentation online. Any quick pointers how I do that, creating the button should be no problem but I don't know how to trigger an internet browser and send it to a specific web address. Any ideas ?

June 20, 2014

Re: [Pharo-dev] The importance of Class Comments

by kilon alios

I think some Spec class comments could be bigger maybe with a couple of sort examples. Now that we have an online reference for Pharo it would be important if class comments are lengthier even if the information is covered in the PFTE Spec tutorial. But I will investigate further to see what I can propose in terms of actual comments. On Fri, Jun 20, 2014 at 11:10 AM, Yuriy Tymchuk <yuriy.tymchuk(a)me.com> wrote: > I have not worked with spec a lot, but I think that itâs nice in terms of > comments, they are very helpful. Also lately Iâve worked with Roassal2 - no > comments at all, but you can ask Alex for help :) > > Uko > > > On 20 Jun 2014, at 10:06, kilon alios <kilon.alios(a)gmail.com> wrote: > > yes good idea Damien , thank you. Right now I am working with Rubric > building a new workspace tool basing it on the rubric example. Spec and > Morphic are on my list too. > > Should I open also an issue on the bug tracker with a slice of my class > comment ? Or is posting it here enough ? > > > On Fri, Jun 20, 2014 at 10:47 AM, Damien Cassou <damien.cassou(a)gmail.com> > wrote: > >> >> On Fri, Jun 20, 2014 at 9:10 AM, kilon alios <kilon.alios(a)gmail.com> >> wrote: >> >>> Saying that I will start adding class comments wherever I can but >>> obviously the people that have created the code are far more qualified than >>> me . >>> >> >> >> I suggest that you ask on this mailing list when you would like to have >> documentation on a class and you can't write it yourself. That way, we all >> will read the answer. Hopefully, someone, will merge this and write a class >> comment. >> >> >> -- >> Damien Cassou >> http://damiencassou.seasidehosting.st >> >> "Success is the ability to go from one failure to another without losing >> enthusiasm." >> Winston Churchill >> > > >

June 20, 2014