php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login

go to bug id or search bugs for

Doc Bug #42827 fread Documentation needs rephrasing/copyedit
Submitted: 2007-10-02 10:37 UTC Modified: 2007-11-21 15:19 UTC
From: bugs at jlevine dot oiiiio dot net Assigned:
Status: Closed Package: Documentation problem
PHP Version: Irrelevant OS: SUSE Linux 10.1
Private report: No CVE-ID: None
View Developer Edit
Welcome! If you don't have a Git account, you can't do anything here.
If you reported this bug, you can edit this bug over here.
(description)
Block user comment
Status: Assign to:
Package:
Bug Type:
Summary:
From: bugs at jlevine dot oiiiio dot net
New email:
PHP Version: OS:

 

 [2007-10-02 10:37 UTC] 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)

Patches

Pull Requests

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2007-11-21 15:19 UTC] vrana@php.net 
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)
"
 
PHP Copyright © 2001-2026 The PHP Group
All rights reserved. 		Last updated: Thu Oct 08 15:00:02 2026 UTC