[squeak-dev] self error: 'comment only' (was: The Trunk: Kernel-eem.1316.mcz)
Das.Linux at gmx.de
Thu Mar 19 08:56:03 UTC 2020
> On 17.03.2020, at 20:02, Thiede, Christoph <Christoph.Thiede at student.hpi.uni-potsdam.de> wrote:
> Hi all,
> of course, I *am* happy about these comments! I see your point not to move them into a far location where you cannot find it quickly. @tim, there are rough plans to make Squeak modular (at least I would appreciate this concern). This should also include the ability to unload help packages, which would be okay if you're not interested to learn how a Transcript works, but it is a fair point that the description of the system should be stored side-by-side to its implementation.
> However, we are talking basically about two comments only at the moment. Couldn't we just move the contents of #whatIsAPrimitive and #howToModifyPrimitives into #primitiveFailed:? Then we would not have these useless method stubs on class side, and even better, the chance for any Squeak Surfers to come across this stuff will be increased. I claim that almost every reader of this documentation comes from any primitive method that states "See Object documentation whatIsAPrimitive." Via debugging/iMplementors browsing, much more people will read any stuff that is located along the caller stack.
I find the documentation-only methods have a kind of charm to them.
I see no real need to merge them somewhere else.
It is more like: If the Class comment doesn't fit what you want to say, put it in a method.
I don't think changing the current state would improve space consumption, speed, discoverability, or so.
Let's keep it :)
> Von: Squeak-dev <squeak-dev-bounces at lists.squeakfoundation.org> im Auftrag von tim Rowledge <tim at rowledge.org>
> Gesendet: Dienstag, 17. März 2020 04:25:28
> An: The general-purpose Squeak developers list
> Betreff: Re: [squeak-dev] self error: 'comment only' (was: The Trunk: Kernel-eem.1316.mcz)
> > On 2020-03-16, at 7:57 PM, David T. Lewis <lewis at mail.msen.com> wrote:
> > These documentation methods are good and useful, and they explain a
> > not-so-obvious aspect of how objects behave. Read them and be happy :-)
> We *could* consider making them appear in the HelpBrowser, or indeed gradually migrating to use of that for such stuff. Since we have it anyway...
More information about the Squeak-dev