January 2019 - Pharo-dev - lists.pharo.org

Re: [Pharo-users] New book: Pharo with Style

by Sean P. DeNigris

Pharo Smalltalk Developers mailing list wrote > Including what the method does, even when the code is fairly simple > (OK, not getter / setter methods), is still useful. Yes, but... there is no free lunch. While there may be a benefit when the code and comment are freshly written and in sync, they are duplication which smells whether code or comment and it is all too easy for the code to be patched without updating the comment. Now that minor speedup turns into a more significant slowdown when a user blindly follows the now-wrong comment. This possibility is made more likely be the fact that a stale comment will not be picked up by the testing framework. ----- Cheers, Sean -- Sent from: http://forum.world.st/Pharo-Smalltalk-Developers-f1294837.html

Jan. 2, 2019

Re: [Pharo-dev] New book: Pharo with Style

by Tudor Girba

Nice work. Doru > On Dec 30, 2018, at 10:13 PM, Stephane Ducasse <stepharo.self(a)gmail.com> wrote: > > Hello Fellow Pharoers > > I'm happy to announce a new little book to improve the culture around Pharo. > I will revise it in the future so you can feel free to send feedback > and pull requests > to https://github.com/SquareBracketAssociates/Booklet-PharoWithStyle > > Stef > > "The best way to predict the future is to invent" so I do it. > <withstylebook.pdf> -- www.feenk.com "To utilize feedback, you first have to acquire it."

Jan. 1, 2019

Re: [Pharo-dev] New book: Pharo with Style

by Sven Van Caekenberghe

That is a useful contribution, thank you (again) for your efforts ! > On 30 Dec 2018, at 22:13, Stephane Ducasse <stepharo.self(a)gmail.com> wrote: > > Hello Fellow Pharoers > > I'm happy to announce a new little book to improve the culture around Pharo. > I will revise it in the future so you can feel free to send feedback > and pull requests > to https://github.com/SquareBracketAssociates/Booklet-PharoWithStyle > > Stef > > "The best way to predict the future is to invent" so I do it. > <withstylebook.pdf>

Jan. 1, 2019

Re: [Pharo-users] [Pharo-dev] New book: Pharo with Style

by Tim Mackinnon

Iâve always felt the XP book nailed it - donât use comments as a crutch to avoid fixing confusing code and donât do work twice by simply writing a comment that says the same as the code. (You can of course try to write the comment and auto-generate the code, but weâve tried that before). Smalltalk is an expressive language that should read like comments naturally - both with the name of a method, the variables and the statements in it. This leaves comments as a good place to tell a story about the wider context and where to look to get started or learn more. I think this is possibly where Documentor is going to help you navigate along the real code. Of course if after all of this you canât figure out how to fix the code - then a comment is a good last resort. Tim Sent from my iPhone > On 1 Jan 2019, at 12:43, Alistair Grant <akgrant0710(a)gmail.com> wrote: > > Hi Richard, > >> On Tue, 1 Jan 2019 at 07:26, Richard O'Keefe <raoknz(a)gmail.com> wrote: >> >> ... >> >> To get an example, I did (String allSelectors atRandom), getting >> #copyWithoutAll:. That has only one definition, in Collection: >> copyWithoutAll: aCollection >> "Answer a copy of the receiver that does not contain any elements >> equal to those in aCollection." >> >> ^ self reject: [:each | aCollection includes: each] >> >> The comment simply paraphrases the rather simple code. > > I agree with pretty much everything you've written, but have a > slightly different view here. > > Including what the method does, even when the code is fairly simple > (OK, not getter / setter methods), is still useful. If the comment is > absent, I have to look at the code, figure out what it does, and then > either figure out if that's what it is supposed to do, or just assume > that I'm correct. Having to figure out whether I've interpreted the > code correctly just increases the cognitive load. If the comment > includes what it is supposed to do, I have a context in which to read > and evaluate the code, and it becomes much less effort. > > Cheers, > Alistair >

Jan. 1, 2019

Re: [Pharo-users] [Pharo-dev] New book: Pharo with Style

by Alistair Grant

Hi Richard, On Tue, 1 Jan 2019 at 07:26, Richard O'Keefe <raoknz(a)gmail.com> wrote: > > ... > > To get an example, I did (String allSelectors atRandom), getting > #copyWithoutAll:. That has only one definition, in Collection: > copyWithoutAll: aCollection > "Answer a copy of the receiver that does not contain any elements > equal to those in aCollection." > > ^ self reject: [:each | aCollection includes: each] > > The comment simply paraphrases the rather simple code. I agree with pretty much everything you've written, but have a slightly different view here. Including what the method does, even when the code is fairly simple (OK, not getter / setter methods), is still useful. If the comment is absent, I have to look at the code, figure out what it does, and then either figure out if that's what it is supposed to do, or just assume that I'm correct. Having to figure out whether I've interpreted the code correctly just increases the cognitive load. If the comment includes what it is supposed to do, I have a context in which to read and evaluate the code, and it becomes much less effort. Cheers, Alistair

Jan. 1, 2019

Re: [Pharo-dev] Happy new year!

by Ben Coman

Thanks everyone for your efforts improving Pharo this year. I hope you've had fun along the way. Its still my favorite pastime. Best wishes for the new year! cheers -ben On Tue, 1 Jan 2019 at 02:02, Esteban Lorenzano <estebanlm(a)gmail.com> wrote: > Hi list, > > Just that. > I wish you all have a happy new year, and may it be even better than this > one :) > > Esteban >

Jan. 1, 2019