php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Bug #55941 PEAR manual needs user comments or examples per method
Submitted: 2003-12-25 18:50 UTC Modified: 2004-06-11 01:10 UTC
From: ramses0 at yahoo dot com Assigned: danielc (profile)
Status: Closed Package: PECL website (PECL)
PHP Version: Irrelevant OS: Linux
Private report: No CVE-ID: None
 [2003-12-25 18:50 UTC] ramses0 at yahoo dot com
Description:
------------
Witness the following: 
 
http://pear.php.net/manual/en/
package.database.db.db.iserror.php 
 
How is this to be invoked? 
 
Where is the example? 
 
Contrast this with the following: 
  http://us2.php.net/manual/en/function.mysql-connect.php 
...and: 
  http://us2.php.net/manual/en/function.mysql-error.php 
 
PHP as a language is only as popular as it is because it 
has very well-written, user-supported (and 
user-supplemented) documentation.  Have you programmed in 
Ruby lately?  I appreciate the documentation that is out 
there, but I feel it is obvious that PEAR needs to 
encourage more user contribution to documentation, like the 
standard PHP documentation does. 
 
--Robert 


Patches

Pull Requests

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2004-01-09 16:36 UTC] mj@php.net
Tobias Schlitt is working on that.
 [2004-01-09 17:00 UTC] toby@php.net
There is a proff of concept for that viewable at http://
zuhause.bei.tobias-schlitt.de:81/manual/en/ . This can at 
the moment only add new comments, which are directly 
viewable. I'll start implementing this today, with admin 
interfaces for package maitainers and website admins. 
 [2004-01-10 15:02 UTC] ramses0 at yahoo dot com
Checked the toby at php.net url and could not figure out how to add comments. Will keep an eye on this, please keep me informed if you?d like feedback.  Thanks for looking at this!
 [2004-03-12 10:18 UTC] toby@php.net
Sorry, guys, but I'm quite to busy to realize this in the upcoming weeks... Maybe someone else can take care of it.
 [2004-06-11 01:10 UTC] danielc at analysisandsolutions dot com
This was fixed a long time ago.  Noticed bug now, so closing it.
 
PHP Copyright © 2001-2024 The PHP Group
All rights reserved.
Last updated: Sat Dec 14 10:01:28 2024 UTC