Posted by stepharo on Oct 20, 2014; 8:02pm
URL: https://forum.world.st/Question-on-Package-comments-SO-tp4785191p4785613.html

Hi nicolai

- ideally I would like a small DSL to describe the key design of a package.

- then the configuration of the package is the place to put a documentation
    https://ci.inria.fr/pharo-contribution/job/PharoProjectCatalog/HTML_Report/
- when the configuration is loaded, the fly by help on the name of the package shows the description.
- we could also use the package manifest.


Christophe is in the process of redoing everything now that my prototype shows that it could work nicely.

Stef

There was a question on SO about documentations for Packages:
http://stackoverflow.com/questions/26292060/is-there-any-pharo-package-reference-documentation

I don't have enough reputation for adding comments in SO,
therefore, I ask the questions here:

The question is closed and I don't understand why.
It is a valid question and I do

remember that this was a topic on this list as well:

show document/help text in configuration browser/
tooltip for packages in Nautilus/

comment package like it is done for classes.

For that user, who asked the question on SO:

At least for external packages there are sometimes some
information on github or squeaksource and we should show him
a link to the pharo user mailing list.

(and no, the http://lmgtfy.com/ link is not helpful nor funny)


nicolai