> >   Modified files:
> >     /phpdoc/en/reference/imap/functions imap-header.xml
> >   Log:
> >   Incorrected formatted function alias - fixed
>
> uhm... why was this incorrect? It's perfectly useful to have the
> parameters listed for deprecated functions.

I sort of disagree. Keeping the syntax for an old functions, which is an
alias to another function, will only cause problems for us. If the "real"
function changes in any way (they add a new parameter for example), then
it's easy for us to change the documentation for the "real" function, but to
keep track of all aliases all the time is wasted time. When I "corrected"
all these functions, I saw 2-3 cases where the parameters had already
changed on the real function.

So I only changed these functions to keep the manual consistent and to make
it easier for us in the future.

http://www.php.net/manual/howto/chapter-conventions.html (#16)
>Aliases: in refpurpose, put: Alias of <function>realfunc</function>. Do not
specify a
>function prototype synopsis, and nothing but simply the text: This function
is an alias
>of <function>realfunc</function>. This way, people can go to realfunc
straight from the
>ref.foo page

If you still disagree with me, just do a CVS rollback ;)

// Victor


-- 
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php

Reply via email to