Re: Payment_Process documentation is worthless

From: Date: Mon, 04 Aug 2008 13:10:20 +0000
Subject: Re: Payment_Process documentation is worthless
References: 1  Groups: php.pear.dev 
Request: Send a blank email to pear-dev+get-50530@lists.php.net to get a copy of this message
Hi Kris, Kristopher Ives wrote: > If boy Bush was a coder he would say it best: "The state of our > documentations are appalling". Payment_Process, which I would consider VERY > important to be properly documented. I understand it's in beta, thats why > I'm working with it. It needs to be stable! Also, AuthorizeNet driver > defaulted to using the production environment - which luckily I was not > activated in. The package also lacks tutorials, which is likely the first > the needed for this package. I totally agree with you. There are basically no documentation and the inline documentation is not always useful. There are a lot of shortcomings. I'd like to refactor the whole package dramatically to utilize a lot more objects rather than arrays and separate things more logically from a application stand point rather than from a payment gateway API. And of course switch to PHP5, which should be permitted given the beta-stage of the package. The package should also be split into sub-packages for each backend. For the record though, the package has been used in production for years, but given the lack of documentation adding new backend is not an easy task. > Example: > > http://pear.php.net/package/Payment_Process/docs/latest/Payment_Process/Payment_Process_Result.html#methodvalidate > > This message is also sent to the author of some of this documentation (Joe > Stump) accourding to the @author tags. FYI Joe and Ian do not maintainer this package anymore. I am the lead developer now. -Philippe

« previous php.pear.dev (#50530) next »