Re: Documentation..

From: Date: Tue, 16 Nov 2004 01:03:51 +0000
Subject: Re: Documentation..
References: 1 2 3 4 5  Groups: php.pear.qa 
Request: Send a blank email to pear-qa+get-1944@lists.php.net to get a copy of this message
Hello Everyone, Let's forget for a moment the lil Daniel/Paul misunderstanding ;) I had the pleasure to meet Daniel in Frankfurt and I really think he is a nice guy, unfortunately is hard to interpret an email tone. (and Paul is a very talented developer too so.. no point to argue I think). We are all saying the same thing more or less. ;) When I started to document other packages (I did net_geo, net_smtp and few others) I realized that it is: a) very time consuming; b) can be useless for many packages, if something changes.... and that : c) I can be very lazy at times ;) The problem was with the testing/examples phase which happens to be very dear to Thomas and many other users. That said, there is no such a thing as a great code without documentation. It is indeed the developer fault if a package is not documented BUT many developers hate docs. So the possible solutions are: a) more writers (as Daniel suggests, I did that too in the beginning and is a simple way to help. If you use a package, you can prepare an example...); b) imposing strict documentation rules (don't think is the case. I know more then one great developers with poor documentation skills. Let's not forget that PHP core developers do not document functions.. there is a doc team). for new packages. Cheers David Costa P.S. we can open a bug report for every non documented package in the stable branch.. if that helps...

« previous php.pear.qa (#1944) next »