search

squeak-smalltalk / squeak-object-memory

Issues and assets related to the Squeak object memory.
https://bugs.squeak.org
MIT License
11 stars 1 forks source link

Installer help topic is not in the Help Browser tree #32

Open tcj opened 2 years ago

tcj commented 2 years ago

I'm not sure if this is intentional or if I'm missing something.

HelpBrowser openOn: Installer

...opens up a page-long, descriptive Installer help topic.

But in the regular Help Browser, the only description of Installer I can find is in Core Packages>>Commonly Used>>Installer, and it is a much smaller one-sentence blurb.

Is there a way (or would it make sense) to get Installer's more descriptive Help topic into the regular Help Browser?

marceltaeumel commented 2 years ago

That's intentional. The HelpBrowser is a flexible tool that can be opened on any list or tree of help books or help topics.

Is there a way (or would it make sense) to get Installer's more descriptive Help topic into the regular Help Browser?

What would that be? I am not aware of any specific InstallerHelp or similar. There is just this class comment. Hmm... I see that Tim (tpr) did overwrite #asHelpTopic especially for Installer to only show the class comment. Not sure why.

Would you prefer the following behavior?

HelpBrowser openOn: (SystemReference forClass: Installer).
tcj commented 2 years ago

Hi @marceltaeumel — my request was basically that the Squeak Help (world menu -> Help -> Squeak Help) content re: Installer is very minimal (one paragraph), while the content seen when performing HelpBrowser openOn: Installer was much more robust. I was trying to suggest presenting the content from HelpBrowser openOn: Installer in Squeak Help instead of what is there now.

But, good catch: I hadn't realized that this more elaborate content was just the class comment :(. Please feel free to close.