#42827 [Opn->Csd]: fread Documentation needs rephrasing/copyedit

ID: 42827 Updated by: vrana@php.net Reported By: bugs at jlevine dot oiiiio dot net -Status: Open +Status: Closed Bug Type: Documentation problem Operating System: SUSE Linux 10.1 PHP Version: Irrelevant New Comment: This bug has been fixed in the documentation's XML sources. Since the online and downloadable versions of the documentation need some time to get updated, we would like to ask you to be a bit patient. Thank you for the report, and for helping us make our documentation better. "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 (after opening userspace stream) " Previous Comments: ------------------------------------------------------------------------ [2007-10-02 10:37:01] bugs at jlevine dot oiiiio dot net 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 this bug report at http://bugs.php.net/?id=42827&edit=1