Re: Documentation..
| From: | Thomas Husfeldt | Date: | Tue, 16 Nov 2004 09:15:18 +0000 |
| Subject: | Re: Documentation.. | ||
| References: | 1 2 3 4 5 6 | Groups: | php.pear.qa |
| Request: | Send a blank email to pear-qa+get-1951@lists.php.net to get a copy of this message | ||
Hi David...
I was by the way in Frankfurt too.. (actually I commented on the same
issue there)..
Firts of all I have nothing against writing documentation, and I also
have no problems documenting or giving feedback on stuff that I know
something about.. - I have actually filled bug reports and added a
couple of comments on the php.net (e.g. howto get oracle working with
PHP5)..
I do not want to impose strict rules on developers - they are doing a
good job and for free, and we would all like that to stay that way.
However I see nothing wrong in politely asking for a simple usage
example (preferably with comments) -- when a new package or a major
upgrade is submitted..
I find it hard to imagine that a high quality PEAR package can be made
without also having some simple code for testing it, and that would in
many cases be sufficient to get an overview or starting point.
So my purpose is not to establish new strict rules or guidlines but
simply to encurage developers and quality assurance folks to focus on
this simple issue -- I think you will gain a lot with a very little
effort..
However - it would probably also be a good idea to make a user
submitted examples section or something like that for the most lazy
developers..
I would enjoy posting examples here if I get to know a package well
enough to be able to submit som usable examples that may help others..