RE: [PEAR-DEV] [Call for Votes] XML_Statistics
| From: | Stephan Schmidt | Date: | Tue, 09 Sep 2003 15:01:59 +0000 |
| Subject: | RE: [PEAR-DEV] [Call for Votes] XML_Statistics | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-21259@lists.php.net to get a copy of this message | ||
Hi,
> Katana has a very good and valid point. Don't contribute to the reason
> why professional won't use PEAR, instead help solve the problem.
I'm already solving problems by contributing code and documentation for my
projects. But my time is limited and if I promise to write docs after the
package is approved, it would be nice of you to believe in me. If I would
add documentation, how do you know I'll fix bugs or continue the
development? You can't be sure, but you should believe me when I say that I
will. This is an open source project, people are not getting paid for what
they do and if I get something for free that is working, I'm happy even if I
have to spend some time figuring out how each method in a package works and
do not complain if documentation does not look like a Windows manual.
What's most important at this point is that the package does what it's
supposed to to and that there's a short description of how to use it.
You do not need to know if the cunstructor does anything, you need to know
what you have to pass to the constructor and as there are no parameters, you
should be able to guess that you do not need to pass in any information.
We are not talking about a SOAP library or something as complex, but about a
small class that counts tags. What do you want me to add to the constructor?
/**
* constructor
*
* Creates a new instance:
* - does not want parameters
* - does not do anything important
*
* @access public
*/
function XML_Statistics()
{
$this->folding = false;
}
How should this help?
I think the example at the top is sufficient for most users:
1. instantiate
2. call analyzeFile()
3. Ask for the stats you like using methods like countTag(), countPI()
If a user is not able to use methods like these, he will surely have
problems using PHP at all.
I don't have a problem with writing documentation, if you are reading
pear-doc, you'll see, that I'm contributing to my packages and I'm even
working on some stuff for the manual, but I'm not willing to contribute a
lot of documentation and then the packages does not get approved.
Stephan