Re: Re: documentation revisioning (was Re: so ckets extension...pecl it)

From: Date: Fri, 13 Sep 2002 16:46:34 +0000
Subject: Re: Re: documentation revisioning (was Re: so ckets extension...pecl it)
References: 1 2  Groups: php.doc 
Request: Send a blank email to phpdoc+get-969348630@lists.php.net to get a copy of this message
> > Yes, this really needs doing -- I've got a few thoughts about how it should > > look, and would be really keen to participate (that is, when I have some > > time -- right now, I'm in the middle of start-of-academic-year hell, so > > it'll be a few weeks before I can even think of it!). > > these are the findings from the php doc meeting > (aka. sterlingrag-meeting) held this spring: > > 13. Version specific issues / Changelogs > We have version/availability information for functions, but there is > no common format or policy for function parameters and > feature/behaviour changes right now. Some changes are documented in > the text, some are put in special or boxes and some are just added to > the documentation without telling they hadn't been available in > previous versions. > > We suggest to add special changelog sections or paragraphs instead to > have all version specific stuff in a single place and to be able to > filter them out on output generation if documentation is to be used > for a current release only where nobody cares about older > releases. This will be implemented using a role='changelog' attribute. > > ( see http://cvs.php.net/co.php/phpdoc/RFC/protocol_20020310 ) We were quite busy to port style sheet behaviour, add constants and now ini information, so some of the findings are actually under work, but we need more help to do all those nice improvements. We welcome any contribution especially for cleaning up and changelog adding tasks ;) User notes can also help in this work highly. Goba

« previous php.doc (#969348630) next »