better fread function manual for non-english speaking people
Nobody has claimed this yet.
- Dominant language
- XML
- Stars
- 596
- Forks
- 890
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 55
Description
Hello,
On this page: https://www.php.net/manual/en/function.fread.php
this section:
if the stream is read buffered and it does not represent a plain file, at most one read of up to a number of bytes equal to the chunk size (usually 8192) is made; depending on the previously buffered data, the size of the returned data may be larger than the chunk size.
is incomprehensible for someone, who is not speaking english on a natural level.
Can you please rephrase this using simple english (like wikipedia does, example: https://simple.wikipedia.org/wiki/Cat ), without using complex language structures, like "at most one read of up"?
Thank you!
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the PHP manual page at https://www.php.net/manual/en/function.fread.php and locate the paragraph describing buffered streams and chunk size. Rewrite that paragraph in simpler English while preserving its technical meaning, then review the rendered wording for clarity.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100