Re-word the way the various read operations are defined
Open
Nobody has claimed this yet.
non-normative/editorial change
- Dominant language
- HTML
- Stars
- 118
- Forks
- 52
- Avg merge
- 9d 16h
- Merged PRs (30d)
- 1
Description
In particular the way the description of the result attribute sort of defines how the result of a read operation is represented is sub-optimal. Some more explicit steps to transform the body returned by the read operation to the various types might make sense.
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
Start by reviewing the File API specification's definitions of the read operations and the description of the result attribute. Clarify the explicit steps that transform a read-operation body into each supported result type, and consider the work done when those transformations are unambiguous.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100