Re: [pear-webmaster] Pear doc error report

From: Date: Wed, 19 Jun 2002 01:08:58 +0000
Subject: Re: [pear-webmaster] Pear doc error report
References: 1 2  Groups: php.pear.webmaster 
Request: Send a blank email to pear-webmaster+get-105@lists.php.net to get a copy of this message
Tomas -- I could live with that, but then list the "parameter" in the docs as $data also. I was very confused with the $file parameter in the docs not matching with the $data "argument" in the function statement (also in the docs) until I finally convinced myself it was an error after digging in the source. Someone reading this documentation is likely to be a newb like me and won't know enough to quickly diagnose the mismatch. Either both should be $data or both should be $file. The latter matches the source. Dave ----- Original Message ----- From: "Tomas V.V.Cox" <cox@idecnet.com> To: "Dave Darden" <dave.darden@bidocean.com> Cc: <pear-webmaster@php.net> Sent: Tuesday, June 18, 2002 6:22 PM Subject: Re: [pear-webmaster] Pear doc error report > As the $data param could be a string or a file name (depending on the > param bool $isfile), I find the name $data enough abstracted. Changing > it to $file would confuse people to think that $data can only be a file. > > Tomas V.V.Cox > > Dave Darden wrote: > Error report -- Pear documentation -- $data should be $file in two functions below: > Mail_mime::addHTMLImage() > mixed addHTMLImage (string $data, string [$c_type = 'application/octet-stream'] [, string $name = '' [, boolean $isfile = true]]) > Mail_mime::addAttachment() > mixed addAttachment (string $data, string [$c_type = 'application/octet-stream'], string [$name = ''], boolean [$isfile = true], string [$encoding = 'base64']) > > =============================================== > David A. Darden > CTO, Bid Ocean, Inc. > An Ocean of Opportunities > www.bidocean.com > 970-254-8673

« previous php.pear.webmaster (#105) next »