RE: [PHP-DOC] A question about the ftp_close function
| From: | Ford, Mike [LSS] | Date: | Fri, 08 Nov 2002 10:30:11 +0000 |
| Subject: | RE: [PHP-DOC] A question about the ftp_close function | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969349481@lists.php.net to get a copy of this message | ||
> -----Original Message-----
> From: Avenger [mailto:avengerphp@hotmail.com]
> Sent: 08 November 2002 08:48
>
> This function 's description say:
>
> "This function is only available in CVS. "
>
> i dont' understand the sentence above.
>
> can ftp_close use in CVS?
>
> or CVS has otherwise mean?
This illustrates a point I've mentioned before. Speaking as someone who spent 10 years or so
as a technical author/editor, I very much think the term CVS should be banned in end-user-oriented
documentation (including the bug-reporting system!). If someone has never come across a
version-control system before, it can be very off-putting to be confronted with this
"geekie" acronym -- even I, with over 25 years' experience in the industry, found it
confusing the first time I came across it, and had to go and look it up in an online glossary.
Wherever possible, the term "CVS" should be replaced with a phrase like "current
development version" -- this gets across the idea that it's not in an officially released
version, but will (Should?) be in a future one that's currently being worked on. Perhaps it
would also be useful if this phrase could be made a link to snaps.php.net...?
There's some other terminology used in various places that's rather "techie" and
I'd like to see replaced with a more plain-language description -- when (or perhaps that should
be IF) I have some spare time, I'd like to identify these and put some proposals to the list.
(And, yes, eventually I'd like to get CVS access and actively help -- I'm especially
interested in the structured argument lists and CHANGELOG proposals that are currently being
discussed.)
Cheers!
Mike
---------------------------------------------------------------------
Mike Ford, Electronic Information Services Adviser,
Learning Support Services, Learning & Information Services,
JG125, James Graham Building, Leeds Metropolitan University,
Beckett Park, LEEDS, LS6 3QS, United Kingdom
Email: m.ford@lmu.ac.uk
Tel: +44 113 283 2600 extn 4730 Fax: +44 113 283 3211