Re: cvs: phpdoc /en/reference/strings/functions implode.xml

On Fri, 6 Jun 2003, Derick Rethans wrote: > On Fri, 6 Jun 2003, John Coggeshall wrote: > > > On Fri, 2003-06-06 at 15:33, Jani Taskinen wrote: > > > > > > Just document the preferred way to use any function. > > > Like in this case, the correct way is to use all parameters: > > > > > > string implode (string glue, array pieces) > > > > If the documentation points out more than one syntax, I consider it > > confusing to not provide that optional syntax as one of the prototypes. > > As Jani said, the *correct* way to use it is with both parameters, > document it as such. This is called 'education', something we do for > *our* users. I struggle with an opinion on this as in one light it should be properly documented, which would mean the two prototype definitions (to go along with the appropriate <note>) but OTOH I'd rather nobody use this unfortunate functionality. After some offlist discussions, it appears some others also feel this new feature is a bit of a bug, and maybe even worth removing in PHP 5. That said, how about we keep revision 1.9 and if removing the functionality becomes a real possability (as discussed by the php-dev team), then remove the <note> altogether. Regards, Philip