Re-word the way the various read operations are defined

Open
#45 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
html
Domain
documentation

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.

Description

non-normative/editorial change

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.

Dominant language
HTML
Stars
118
Forks
52
Avg merge
9d 16h
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from w3c/FileAPI

All issues in w3c/FileAPI

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.