Re: Missing package documentation reminder
| From: | Helgi Þormar | Date: | Tue, 07 Nov 2006 14:46:30 +0000 |
| Subject: | Re: Missing package documentation reminder | ||
| References: | 1 | Groups: | php.pear.qa |
| Request: | Send a blank email to pear-qa+get-4052@lists.php.net to get a copy of this message | ||
Is this a joke ? I mean really ?
Aren't we sending out enough global emails as it is ?
At least I remember when I made the whole "send out bug report reminders"
then I almost got teared a new one.
Will these emails be sent out monthly or ?
Btw. it's "stupid" to say a package is useless without docs because that's
simply false information :) even tho only the devs will see these
emails, especially when the package is marked as beta, if those emails are
going to be sent out then please do so only on stable package where I'm
actually listed ... Use the database, not an outdated package.xml file (it
even seems a bit of wasted cycles to use the package xml because we have a
DB for this stuff)
Even a better idea is to send these emails out only on maintained packages (
i.e. not marked as unmaintained or deprecated)
Just my 2 cents, might have missed siome discussion about this since I only
look at the lists ever so often but so it goes, I got rather curde internet
access at work so I can't really look it up.
- Helgi
On 11/7/06, pear-qa@lists.php.net <pear-qa@lists.php.net> wrote:
Dear PEAR developer, Some of your packages in PEAR do not have end-user documentation in the official PEAR manual. Since the best package is useless without proper documentation, we ask you to write that for the packages not having any. And do remember that the auto-generated API-documentation does not replace end-user documentation as found in the manual. Use case and examples as well as an introduction to the way the package works is invaluable to the user wishing to use it. Your packages missing documentation: Cache, Tree If you have already written documentation located on an external server, plase consider transferring it into the PEAR manual. If that is not possible we ask you to create a link in the PEAR manual pointing to it. In case you are not a developer of one of the mentioned packages, the information in the package.xml file is wrong. Ask the lead of that package to correct the data. Regards, The PEAR QA team.