#42827 [NEW]: fread Documentation needs rephrasing/copyedit
| From: | bugs at jlevine dot oiiiio dot net | Date: | Tue, 02 Oct 2007 10:37:02 +0000 |
| Subject: | #42827 [NEW]: fread Documentation needs rephrasing/copyedit | ||
| Groups: | php.doc.bugs | ||
| Request: | Send a blank email to doc-bugs+get-51@lists.php.net to get a copy of this message | ||
From: bugs at jlevine dot oiiiio dot net
Operating system: SUSE Linux 10.1
PHP version: Irrelevant
PHP Bug Type: Documentation problem
Bug description: fread Documentation needs rephrasing/copyedit
Description:
------------
The second sentence of the first paragraph in the documentation for the
function fread() is unclear/difficult to read as currently displayed at
http://php.net/manual/en/function.fread.php
"Reading stops when up to length bytes have been read, EOF (end of file)
is reached, (for network streams) when a packet becomes available, or
(after opening userspace stream) when 8192 bytes have been read whichever
comes first."
Possibly this long sentence could be easier understood if formatted as a
list instead of as prose. At the very least the "whichever comes first"
should be broken off into a separate sentence.
I suggest a UL along these lines:
"Reading stops as soon as one of the following conditions is met:
*/length/ bytes have been read
*EOF (end of file) is reached
*a packet becomes available (for network streams)
*8192 bytes have been read (for userspace streams)
--
Edit bug report at http://bugs.php.net/?id=42827&edit=1
--
Try a CVS snapshot (PHP 4.4): http://bugs.php.net/fix.php?id=42827&r=trysnapshot44
Try a CVS snapshot (PHP 5.2): http://bugs.php.net/fix.php?id=42827&r=trysnapshot52
Try a CVS snapshot (PHP 6.0): http://bugs.php.net/fix.php?id=42827&r=trysnapshot60
Fixed in CVS: http://bugs.php.net/fix.php?id=42827&r=fixedcvs
Fixed in release: http://bugs.php.net/fix.php?id=42827&r=alreadyfixed
Need backtrace: http://bugs.php.net/fix.php?id=42827&r=needtrace
Need Reproduce Script: http://bugs.php.net/fix.php?id=42827&r=needscript
Try newer version: http://bugs.php.net/fix.php?id=42827&r=oldversion
Not developer issue: http://bugs.php.net/fix.php?id=42827&r=support
Expected behavior: http://bugs.php.net/fix.php?id=42827&r=notwrong
Not enough info: http://bugs.php.net/fix.php?id=42827&r=notenoughinfo
Submitted twice: http://bugs.php.net/fix.php?id=42827&r=submittedtwice
register_globals: http://bugs.php.net/fix.php?id=42827&r=globals
PHP 3 support discontinued: http://bugs.php.net/fix.php?id=42827&r=php3
Daylight Savings: http://bugs.php.net/fix.php?id=42827&r=dst
IIS Stability: http://bugs.php.net/fix.php?id=42827&r=isapi
Install GNU Sed: http://bugs.php.net/fix.php?id=42827&r=gnused
Floating point limitations: http://bugs.php.net/fix.php?id=42827&r=float
No Zend Extensions: http://bugs.php.net/fix.php?id=42827&r=nozend
MySQL Configuration Error: http://bugs.php.net/fix.php?id=42827&r=mysqlcfg