note 35271 added to function.fread
| From: | php-general at lists dot php dot net | Date: | Tue, 26 Aug 2003 07:00:36 +0000 |
| Subject: | note 35271 added to function.fread | ||
| Groups: | php.notes | ||
| Request: | Send a blank email to php-notes+get-55072@lists.php.net to get a copy of this message | ||
guys, please leave more of the user
supplied examples in the comments!
It doesn't do any good for you to
decide that your revised docs are
enough for the masses - one of the
most compelling things about php
as a language is that you have the
BEST documentation in the world,
as supplied by your users.
Your official examples are often
weak by comparison, and drag down
the quality of the docs in general.
For example, the string functions
used to be well illustrated. Now,
they're approaching mystery again.
It's a throwback to simply spec'ing
the grammar in BNF form, and by
failing to provide reasonably
complete collections of examples-
(AKA code snippets that are *not*
simply arg1, arg2, arg3) you are
doing your userbase a disservice.
When you decide to clean out the
examples, you're stripping some
of the best information available.
Please don't take this wrong - I
wish PHP the best of luck, and it's
my fave prototyping language. But I
keep feeling like I should be archiving
all the example code monthly so we
don't lose all those useful snippets-
and by useful, i mean even those lame
little snippets that simply shed some
light on the syntax.
----
Manual Page -- http://www.php.net/manual/en/function.fread.php
Edit Note -- http://master.php.net/manage/user-notes.php?action=edit+35271
Delete Note -- http://master.php.net/manage/user-notes.php?action=delete+35271&report=yes
Reject Note -- http://master.php.net/manage/user-notes.php?action=reject+35271&report=yes