On Fri, Jun 24, 2016 at 10:55 PM, Cl��ment Bera <bera.clement@gmail.com> wrote:
Hi.

Pragmas are selectors hence they're browsable. You can implement a method somewhere with the pragma selector name that includes the documentation. In VW they were careful about that and most, if not all, of their pragmas are carefully commented this way.


Should this be concentrated in a class like PragmaDocumentation, or spread out (I don't know how).

cheers -ben��
��
For example, if you have the pragma <foo> and you implement the method MyClass class >> #foo with some comments in it and you can double click on the pragma <foo> to select its content (foo) and press Cmd+M (or right click implementors) to get to the method having the documentation.

��

On Fri, Jun 24, 2016 at 3:54 PM, Alexandre Bergel <alexandre.bergel@me.com> wrote:
Hi!

A pragma may be very obscure. For example, I do:��
Pragma allInstances anyOne
=> <debuggerCompleteToSender>

If I want to know more about this <debuggerCompleteToSender> is actually quite challenging.��
I see many methods having that pragma, but not idea what it is for.��
I see that Halt>>signalerContext and Process>>complete: that use that pragma somehow. But still, I have no idea when I should use that pragma in my method.

What about having a way to comment pragma? Maybe something like��
-=-=-=-=-=-=
Object subclass: #Pragma
instanceVariableNames: 'method keyword arguments comment'
-=-=-=-=-=-=

And a simple way to annotate pragmas?
Just an idea.��

Cheers,
Alexandre
--��
_,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:
Alexandre Bergel ��http://www.bergel.eu
^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.