Re: Should examples be CLI or WEB output?

From: Date: Fri, 23 Apr 2010 15:31:28 +0000
Subject: Re: Should examples be CLI or WEB output?
References: 1 2  Groups: php.doc 
Request: Send a blank email to phpdoc+get-969381695@lists.php.net to get a copy of this message
On Fri, Apr 23, 2010 at 14:15, Daniel Convissor <danielc@analysisandsolutions.com> wrote: > Hi Richard: > > On Fri, Apr 23, 2010 at 10:45:07AM +0100, Richard Quadling wrote: >> >> Just looking through some of the DateTime examples and noticed that >> they are using <br /> as a line terminator. > > I agree, CLI output is preferable. > > Several of the DateTime examples are overblown in general.  The one > DateTime::add() <example> has six sample statements in it.  For such a > simple function, only one example is necessary. I like multiple examples, especially when combined with a complicated bastard as DateInterval. > I'm in the middle of doing a spring cleaning on the DateTime docs. > Integrating and pruning user comments, improving the format and > simplifying examples.  I'll change the <br />'s as part of that. The <br> seem useless. But an <screen> would definitely be good idea. -Hannes

« previous php.doc (#969381695) next »