Re: <example> pragmas and example* methods use-cases
Posted by
Ben Coman on
Jun 30, 2015; 12:52pm
URL: https://forum.world.st/example-pragmas-and-example-methods-use-cases-tp4833428p4834896.html
On Tue, Jun 30, 2015 at 2:10 AM, Sean P. DeNigris <
[hidden email]> wrote:
> Peter Uhnák wrote
>> It seems that
>> <sample>
>> is then the go-to naming for now
>
> I agree with Ben that from a native English perspective, exemplar doesn't
> quite sound right.
>
> Sample and Example are the two words that most clearly capture the intent.
> The problem with using #sample to return instances and #example to
> illustrate usage is that it's a bit too subtle. Even though technically one
> could argue the logic of that distinction, in reality English speakers use
> them interchangeably and it will be confusing.
Thats a fair argument.
> A core principle of Smalltalk
> is to type a bit more to make things clearer (e.g. avoid
> single-character/abbreviated variable names). I strongly feel we should be
> more specific and uniform by either using (<exampleInstance> &
> <exampleCode>) or (<sampleInstance> & <sampleCode>).
I find myself liking the last two, I think since the concatenated
words rolls off the tongue nicer with one less syllable, but I think
any of those are fine. Actually, rather than pairing based on the
first part, maybe using <exampleCode> together with <sampleInstance>
will distinguish the most between the two cases.
cheers -ben