On Sun, 2 Feb 2003, Zak Greant wrote: > On Sun, Feb 02, 2003 at 09:22:43PM +0100, Maxim Maletsky wrote: > ... > > > Heh. The content is already in docbook and the user notes are mostly > > > useless already. ;) > > > > I hope you meant they are outdated in some parts. Because, the user > > notes are very very usefull for tons of people. It 1) suggests a > > function's usage 2) extends the documentation (often they are bugs > > and/or what is getting into the official description). Though a cleanup > > would be good. > > Hello Goba and Maxim, > > Perhaps we don't need to Cc: group or rasmus on this variant of the > discussion? :) > > To be very precise, what I meant was many of the submitted notes are > wrong or partially wrong. I understand that some of the notes have > significant value. > > > What I would also like to see in user notes are the examples. Something > > that allows someone to choose whether it is a note or this adds an > > additional example of usage for the given function. > > > > Not sure if I render you the idea, but the point is to have a comments > > of the function and the code serving as a sample of usage separate and > > clearer, perhaps even highlighted. > > IIRC, there have been a few discussions to separate the notes into > categories - tip, example, correction, etc. I think that it was often > decided that it was best to just integrate the notes into the > documentation periodically.
Agreed. Also, the PHP manual is not a code repository nor should it be ... especially one full of unmoderated not-so-optimal codes. It's difficult enough keeping all bogus notes out let alone moderate which code snippets belong. We don't want "official" PHP.net code snippets as the PHP community at large is around to fill this gap. Regards, Philip -- PHP Documentation Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
