> Something like this problem was discussed on our meeting at Stuttgart.
> We came up with the idea of including a "Changelog" on all function
> pages where it is needed. We can't freeze the docs for specific PHP
> versions as we often discover undocumented features let's say, from
> PHP 4.0.0... That means that we have documented behaviour of functions
> only available in CVS, but often we have no updated documentation for
> some functions which changed their behaviours releases before. Our
> documentation is dinamicaly changing in all directions...

Well, the case of undiscovered functions in older releases would be solved
with CVS branches.  Simply add the documentation to the PHP_4_0_0 branch,
and every branch since then.

In an IRC chat with Derrick, it was brought up that getting translators to
work with CVS branches could possibly make my idea undoable (i.e., it's
asking too much of people to learn how to use branches properly).
Personally, I disagree, but that can be discussed here as well.

The Changelog idea would be an excellent addition to the docs.  You'd need
to figure out how to handle functions that get dropped (like xmlfile(), for
instance).  I suppose that could go in the Changelog for the main DOMXML
introduction page (but then would there be any docs for obsolete
functions?).

And incorporating something like http://www.zend.com/phpfunc/ into the PHP
docs would be a big benefit, I think.  Hrmm ... it even looks like it
handles obsoleted functions.

- Colin


Reply via email to