Re: Documentation..
| From: | David Costa | Date: | Mon, 15 Nov 2004 15:13:55 +0000 |
| Subject: | Re: Documentation.. | ||
| References: | 1 | Groups: | php.pear.qa |
| Request: | Send a blank email to pear-qa+get-1938@lists.php.net to get a copy of this message | ||
Hello Thomas,
thanks for your suggestion. I have been working on an updated list and call from action from other developers.
Unfortunately I am currently snowed under (work) but.. if you have a package that is very dear to you feel free to message me and the maintainer.
I think it would be good to have even external user documentation if not on the manual (e.g. on my package Db_Sqlite_Tools I do have the external user documentation linked on the package page).
Cheers
David Costa
On Nov 15, 2004, at 3:54 PM, Thomas Husfeldt wrote:
A lot of pear packages does not have end user documentation.. I get the message "No end-user documentation is available for this package.". I would really like to have this improved.. It can be a tedious to figure out what a pear package does/offers just from reading the API.. In other words I would like you to please demand or strongly request a minimal end-user -- like a "hello world" example for the various pear packages.. It will make it lot easier to quickly get an overwiew of a given package.. and as the number of packages is growing string it will be very cumbersome to read API's for all the packeges to get the rigth one or just to find out if it actually exists.. BTW -- keep up the good work -- this is ofcourse a wish not a complain :) /Thomas Husfeldt -- PEAR QA Mailing List (http://pear.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php