[Pharo-project] System Browser - shifting class comments into pane beneath class definition
I could not find any previous discussion of this so I'll just throw this out there... I find that I forget to click the "?" button to read the class comments as I browse around the system. They are "kind of" hidden. Perhaps also I stop looking because they are often empty. If others do the same then it is a downward spiral... if it seems no one looks at them then no one values writing them. (Except for the good work of the COTDC) However System Browser opens by default with 16 lines. Most class definitions (eg [1]) use 6 lines, which leaves a lot of unused whitespace. I wonder if the class comment was to appear (in a separate pane) beneath the class definition then the class definition would be filled out more often. Bring the class comments to the fore and perhaps they'll be valued more. At least for me, it will ensure that I don't miss where there are good comments I can learn from. Also more attention may focus on the poor comments due to being more exposed. just a random thought... cheers, Ben [1] Object subclass: #Behavior uses: TPureBehavior instanceVariableNames: 'superclass methodDict format' classVariableNames: 'ObsoleteSubclasses' poolDictionaries: '' category: 'Kernel-Classes'
Hi Ben. For me it would make a lot of sense. I have already argued several times that "?" is amazingly hidden. NOBODY can see it. You must have a 5 years Pharo degree to find it ;) The problem is OB, I am not sure if it is supported by OB and if it is, I don't know how to enable it. Moreover, if you take a look to Pharo 1.4 (where OB is not present), you will find that the System Browser in there, has what you want. Cheers On Tue, Dec 27, 2011 at 4:04 PM, Ben Coman <btc@openinworld.com> wrote:
I could not find any previous discussion of this so I'll just throw this out there...
I find that I forget to click the "?" button to read the class comments as I browse around the system. They are "kind of" hidden. Perhaps also I stop looking because they are often empty. If others do the same then it is a downward spiral... if it seems no one looks at them then no one values writing them. (Except for the good work of the COTDC)
However System Browser opens by default with 16 lines. Most class definitions (eg [1]) use 6 lines, which leaves a lot of unused whitespace. I wonder if the class comment was to appear (in a separate pane) beneath the class definition then the class definition would be filled out more often. Bring the class comments to the fore and perhaps they'll be valued more. At least for me, it will ensure that I don't miss where there are good comments I can learn from. Also more attention may focus on the poor comments due to being more exposed. just a random thought... cheers, Ben
[1] Object subclass: #Behavior uses: TPureBehavior instanceVariableNames: 'superclass methodDict format' classVariableNames: 'ObsoleteSubclasses' poolDictionaries: '' category: 'Kernel-Classes'
-- Mariano http://marianopeck.wordpress.com
Mariano Martinez Peck wrote:
Hi Ben. For me it would make a lot of sense. I have already argued several times that "?" is amazingly hidden. NOBODY can see it. You must have a 5 years Pharo degree to find it ;)
The problem is OB, I am not sure if it is supported by OB and if it is, I don't know how to enable it. Moreover, if you take a look to Pharo 1.4 (where OB is not present), you will find that the System Browser in there, has what you want.
Good to know. thanks Mariano. Pharo 1.4 is just what I was thinking, except that when the window is resized, rather than holding the split at 50%, I'd prefer the class definition pane size held fixed and let more of the class comment show.
On Tue, Dec 27, 2011 at 4:04 PM, Ben Coman <btc@openinworld.com> wrote:
I could not find any previous discussion of this so I'll just throw this out there...
I find that I forget to click the "?" button to read the class comments as I browse around the system. They are "kind of" hidden. Perhaps also I stop looking because they are often empty. If others do the same then it is a downward spiral... if it seems no one looks at them then no one values writing them. (Except for the good work of the COTDC)
However System Browser opens by default with 16 lines. Most class definitions (eg [1]) use 6 lines, which leaves a lot of unused whitespace. I wonder if the class comment was to appear (in a separate pane) beneath the class definition then the class definition would be filled out more often. Bring the class comments to the fore and perhaps they'll be valued more. At least for me, it will ensure that I don't miss where there are good comments I can learn from. Also more attention may focus on the poor comments due to being more exposed. just a random thought... cheers, Be
This is good point. we should give more space to class comments. On Dec 27, 2011, at 4:04 PM, Ben Coman wrote:
I could not find any previous discussion of this so I'll just throw this out there...
I find that I forget to click the "?" button to read the class comments as I browse around the system. They are "kind of" hidden. Perhaps also I stop looking because they are often empty. If others do the same then it is a downward spiral... if it seems no one looks at them then no one values writing them. (Except for the good work of the COTDC)
However System Browser opens by default with 16 lines. Most class definitions (eg [1]) use 6 lines, which leaves a lot of unused whitespace. I wonder if the class comment was to appear (in a separate pane) beneath the class definition then the class definition would be filled out more often. Bring the class comments to the fore and perhaps they'll be valued more. At least for me, it will ensure that I don't miss where there are good comments I can learn from. Also more attention may focus on the poor comments due to being more exposed. just a random thought... cheers, Ben
[1] Object subclass: #Behavior uses: TPureBehavior instanceVariableNames: 'superclass methodDict format' classVariableNames: 'ObsoleteSubclasses' poolDictionaries: '' category: 'Kernel-Classes'
I would also state that the compilation should fail if there is no change to the default class comment when a method is written and saved. Aggessively expect even methods to have at least some comment, unless they are accessors or the likes. Will force the habit for future incremental code On Dec 27, 2011, at 9:21 PM, Stéphane Ducasse <stephane.ducasse@inria.fr> wrote:
This is good point. we should give more space to class comments.
On Dec 27, 2011, at 4:04 PM, Ben Coman wrote:
I could not find any previous discussion of this so I'll just throw this out there...
I find that I forget to click the "?" button to read the class comments as I browse around the system. They are "kind of" hidden. Perhaps also I stop looking because they are often empty. If others do the same then it is a downward spiral... if it seems no one looks at them then no one values writing them. (Except for the good work of the COTDC)
However System Browser opens by default with 16 lines. Most class definitions (eg [1]) use 6 lines, which leaves a lot of unused whitespace. I wonder if the class comment was to appear (in a separate pane) beneath the class definition then the class definition would be filled out more often. Bring the class comments to the fore and perhaps they'll be valued more. At least for me, it will ensure that I don't miss where there are good comments I can learn from. Also more attention may focus on the poor comments due to being more exposed. just a random thought... cheers, Ben
[1] Object subclass: #Behavior uses: TPureBehavior instanceVariableNames: 'superclass methodDict format' classVariableNames: 'ObsoleteSubclasses' poolDictionaries: '' category: 'Kernel-Classes'
participants (4)
-
Ben Coman -
Krishsmalltalk -
Mariano Martinez Peck -
Stéphane Ducasse