[squeak-dev] Re: [Documentation] What about package comments?

Eliot Miranda eliot.miranda at gmail.com
Fri Sep 3 17:19:55 UTC 2010


On Fri, Sep 3, 2010 at 2:51 AM, Bert Freudenberg <bert at freudenbergs.de>wrote:

> On 03.09.2010, at 10:28, Hannes Hirzel wrote:
>
> > On of the things I have been wondering recently is where the package
> actually "lives" in the image.
>
> A package is a (sub-) instance of PackageInfo. Packages are held by
> PackageOrganizer.
>
> One idea would be to include a PackageInfo subclass in each package, and
> its class comment or methods would describe the package. That would hook
> into HelpSystem so one could browse comments, instructions, examples etc.
> per package.
>
> There are a few conventions for that already, e.g. the class name should
> end in "Info" and it should be in a category named "PackageName-Info".
>

This is nice.  It's also a place to put package initialization/unloading
scripts, etc.  Is there example code for the above conventions anywhere?

cheers
Eliot


>
> - Bert -
>
>
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.squeakfoundation.org/pipermail/squeak-dev/attachments/20100903/066e0f39/attachment.htm


More information about the Squeak-dev mailing list