Re: PHP3 Documentation
| From: | Richard Lynch | Date: | Fri, 10 Sep 1999 18:43:42 +0000 |
| Subject: | Re: PHP3 Documentation | ||
| References: | 1 | Groups: | php.mirrors |
| Request: | Send a blank email to php-mirrors+get-446@lists.php.net to get a copy of this message | ||
At 10:43 PM 9/9/99 -0400, you wrote:
>I apologize for using your personal email address. However, no official
>contact link was provided on the PHP website.
No problem, really. Though my contribution to "Documentation" primiarily
consists of answering far too many emails to the mailing list from people
who didn't read the docs, the FAQ, the website, or the archives of
contributed code and emails. :-^
I'm not sure what official contact link you were hoping for, but
webmaster@php.net would work fine, or you could use the "Add Note" feature
on the web to add a note in any particular place you thought the
documentation lacking.
>First of all, PHP is great, and I really appreciate the work that you
>and many others have put into it and its excellent documentation system.
Yay!
>However, I just wanted to know what the heck PHP4 functions were doing
>in the PHP3 documentation. I know they are marked as such, but it is
>only subtly. At any rate, they should not be there at all. There
>should be a seperate PHP4 documentation system--or better yet have a
>field for version in the documentation database and allow users to
>specify a max version number when browsing the docs.
These are some interesting ideas.
Maintaining two separate sets of documentation for PHP3 and PHP4 is
probably not a realistic option. The developers aren't getting paid or
anything, and even the one set is quite daunting.
But you are almost certainly right, imho, that the PHP4 notation, or other
demarkation of version additions, would be better placed more prominently
in the existing docs -- perhaps up by the function name itself.
Formalizing the notification of when functions appeared directly into the
docs would be nifty -- perhaps even notations when functions are changed
could be included. But this is not a trivial feature: Presumably not
every little change would be worth noting and tying in with version control
information.
>I feel this is an important issue.
Oui. D'accord. Perhaps you'd like to volunteer to set it up?
http://www.php.net/cvs.htm or http://cvs.php.net would be the appropriate
place to begin that process.
>If you no longer work on the PHP documentation, you have my sincere
>apologies and should ask the admin of the PHP website to make a note of
>this on the Development Credits page.
I receive several emails a month that have always baffled me as to why the
sender thinks I'm the "first person listed in the documentation". You are
the first to provide me with the explanation for this: On the credits
page, where contributors are listed alphabetically, I am the first person
to appear with "Documentation" under my name. Ah hah!
I'm still trying to figure out this CVS stuff (and failing miserably), but
hope to be able to edit that to say something like "Guy Who Answers The PHP
Emailing List Far Too Often". :-)
It should definitely not contain an e-mail address that is doomed to die,
without notice. ceo@L-I-E.com is an email which always be valid, at least
until I die. lynch@lscorp.com is from 1.5 jobs ago, and still forwarding,
by some minor miracle (an a really cool systems support guy).
At any rate, I've rambled enough now. Thanks for writing to us!
--
"TANSTAAFL" Websites I have built:
CHaTMusic.com EmphasisEntertainment.com L-I-E.com
JadeMaze.com CatCatalani.com MGMH.com
AstraKelly.com OlivierLedoux.com