[Cuis-dev] A suggestion for Cuis Meeting

[Hernán Wilkinson]

yeah, it is a simple but powerful paper :-)

On Tue, Apr 1, 2025 at 1:14 PM Luciano Notarfrancesco <luchiano at gmail.com>
wrote:

> Haha, great, I was worried to be saying something too obvious. The paper
> is very nice, I don’t remember seeing it before, thanks!
>
> On Tue, Apr 1, 2025 at 22:51 Hernán Wilkinson <
> hernan.wilkinson at 10pines.com> wrote:
>
>> Bobby Wolf suggested the same thing of documenting just the superclass
>> methods in his paper "Polymorphic Hierarchies", a paper of 1996 😛😛😛
>> Here is the link:
>> https://www.dropbox.com/s/jyy87o2a3ljdr7w/Polymorphic%20Hierarchy.pdf?dl=0
>>
>> On Tue, Apr 1, 2025 at 8:48 AM Luciano Notarfrancesco via Cuis-dev <
>> cuis-dev at lists.cuis.st> wrote:
>>
>>> Hi Hilaire,
>>> I have a couple of suggestions:
>>> If only comments are changed, I’d try to keep the original author
>>> initials.
>>> Also, I’d suggest to focus on documenting the main protocols instead of
>>> internal details that might change.
>>> And finally a thing I do in my projects: when I have a hierarchy of
>>> classes and a method is implemented in many of them, I only comment the
>>> method in the superclass (I avoid copying the comment to the
>>> implementations in subclasses because changing it later is harder, better
>>> keep things in one place).
>>> And finally finally, someone in other project was recently talking about
>>> “four types of documentation” and posted this link where the idea is
>>> explained, I thought you might find it interesting too:
>>> https://docs.divio.com/documentation-system/
>>>
>>> Cheers,
>>> Luciano
>>>
>>> On Tue, Apr 1, 2025 at 00:15 Hilaire Fernandes via Cuis-dev <
>>> cuis-dev at lists.cuis.st> wrote:
>>>
>>>> For this Wednesday we can make a test drive.
>>>>
>>>> Naive idea:
>>>>
>>>> - we pickup a class or hierarchy we want to improve the understanding
>>>> with comments, code examples,...
>>>>
>>>> - One will share its screen with the latest Cuis-Smalltalk-dev image,
>>>> this person will be the editor. Suggestion: should be a native English
>>>> writer
>>>>
>>>> - I can still video record the experience
>>>>
>>>> Advice on the set up ?
>>>>
>>>> Opinion on class to work on?
>>>>
>>>>
>>>> -- http://mamot.fr/@drgeo
>>>>
>>>> --
>>>> Cuis-dev mailing list
>>>> Cuis-dev at lists.cuis.st
>>>> https://lists.cuis.st/mailman/listinfo/cuis-dev
>>>>
>>> --
>>> Cuis-dev mailing list
>>> Cuis-dev at lists.cuis.st
>>> https://lists.cuis.st/mailman/listinfo/cuis-dev
>>>
>>
>>
>> --
>>
>> *Hernán WilkinsonAgile Software Development, Teaching & Coaching*
>> *Phone: +54-011*-4893-2057
>> *Twitter: @HernanWilkinson*
>> *site: http://www.10Pines.com <http://www.10pines.com/>*
>> Address: Alem 896, Floor 6, Buenos Aires, Argentina
>>
>

-- 

*Hernán WilkinsonAgile Software Development, Teaching & Coaching*
*Phone: +54-011*-4893-2057
*Twitter: @HernanWilkinson*
*site: http://www.10Pines.com <http://www.10pines.com/>*
Address: Alem 896, Floor 6, Buenos Aires, Argentina
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.cuis.st/mailman/archives/cuis-dev/attachments/20250401/eea3dac6/attachment.htm>