Re: WS, phpdoc, and you :)
| From: | Andrew Lindeman | Date: | Wed, 09 Apr 2003 20:41:00 +0000 |
| Subject: | Re: WS, phpdoc, and you :) | ||
| References: | 1 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969352518@lists.php.net to get a copy of this message | ||
On Wed, 2003-04-09 at 14:38, Philip Olson wrote:
> On Wed, 9 Apr 2003, Gabor Hojtsy wrote:
> > >>>b) Check our coding standards, we always put the
> > >>>braces like:
> > >>>
> > >>> if () {
> > >>> } else {
> > >>> }
> > >>
> > >>No problem. I looked through the documentation howto, and I may have
> > >>just overlooked this, but I don't see standards in there. Are we using
> > >>the PEAR standard?
> > >
> > > Yeah. I thought it was official but I also don't see
> > > this in the howto, it'll be added.
> >
> > It was there, but was commented out as Egon asked for it. I don't think
> > anybody else opposes using PEAR standards, and most of the doc guys use
> > it anyway, so it may appear again in the howto IMHO...
>
> After sifting through the archives and pondering for a
> moment, I conclude the following:
>
> 1) We use the PEAR standard anyway
> 2) It makes sense to be consistent
> 3) The PEAR standard is commonly used in the community
> 4) Most agree with it now, and most agreed 1.5 years ago
>
> Related threads:
>
> A few discussions:
> http://marc.theaimsgroup.com/?l=phpdoc&m=99572506105176
> http://marc.theaimsgroup.com/?l=phpdoc&m=99722422403729
> http://marc.theaimsgroup.com/?l=phpdoc&m=100818601731475
> http://marc.theaimsgroup.com/?l=phpdoc&m=100906070832340
>
> The commented out commit:
> http://marc.theaimsgroup.com/?l=phpdoc&m=100841247616700
>
> Summary of provided reasons not to use it (keep in mind
> this was mostly discussed 1.5 years ago):
>
> 1) Wasn't discussed
> 2) Manual was written before the pear standard existed
> 3) Free spirit and/or dislike of individual pear standards
>
> If someone feels a need to submit a patch that updates the
> entire manual at once to pear standards, that's fine. If
> we make the standard official, people will adhere to it in
> the future and hopefully this won't cause too much clutter
> to CVS (it shouldn't, people learn from mistakes :).
>
> +1 on making it very clear that phpdoc follows the
> PEAR standards, in both the README and HOWTO.
> And, forcing its use for all future commits.
>
> Regards,
> Philip Olson
Sounds good to me
+1
--Andrew
--
Andrew Lindeman <alindeman@php.net>