Re: Real documentation?

Yup, examples/tests should be included. I did it for Science/Chemistry (I know I ought to rename it to Science_Chemistry or Sci_Chem or something), see: http://cvs.php.net/cvs.php/pear/Science/Chemistry/test Ideally we would have a tag like @example which will be parsed and put into the documentation genater by PHPDoc (or similar tool), but for now I think we can include the examples in the class description, it should not work and not break anything AFAICT --- Richard Heyes <richard.heyes@heyes-computing.net> wrote: > > Does anyone have any interest in including real documentation in PEAR? ie. > Hand typed examples and instructions on usage? These could go in the class > files themselves, or maybe a similar named file as the class, eg > Mail/sendmail.txt, Mail/RFC822.txt, Mail/smtp.txt etc. > > Comments? > > -- > Richard Heyes > "I know not with what weapons World War III will be fought, but World War IV > will be fought with sticks and stones." - Albert Einstein > > > -- > PEAR Development Mailing List (http://pear.php.net/) > To unsubscribe, e-mail: pear-dev-unsubscribe@lists.php.net > For additional commands, e-mail: pear-dev-help@lists.php.net > To contact the list administrators, e-mail: php-list-admin@lists.php.net > ===== --- Jesus M. Castagnetto (jcastagnetto@yahoo.com) __________________________________________________ Do You Yahoo!? Send instant messages & get email alerts with Yahoo! Messenger. http://im.yahoo.com/