Fix fio.pread description
Open
Nobody has claimed this yet.
factual error
reference
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
fh:pread() doc says that it has only two formats:
fh:pread(size, offset)fh:pread(buf, size, offset)
While the last argument offset has an implicit default equals 0. Actual usage is:
fh:pread([buf,] size, offset = 0)
Contributor guide
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 linked fh:pread() reference page under reference_lua/fio and inspect its argument-format description. Update the documented signatures to show that offset defaults to 0, then verify the page no longer presents only the two-argument forms.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100