Improve the docs regarding errors.
Nobody has claimed this yet.
- Dominant language
- Dart
- Stars
- 1.1k
- Forks
- 419
- Avg merge
- 4d 14h
- Merged PRs (30d)
- 8
Description
I was reading the docs trying to help someone out in StackOverflow on how to show an upload progress, and I came across StreamedRequest.sink, which isn't clear how data is being sent.
The docs say data added to the sink will be sent, but how guaranteed is this? If the client can't send a particular data chuck, will I get an error immediately? Will the error come later? Does it auto-retry?
If the error comes later than I have false sense of completion as the data hasn't been sent but I think it has been.
The docs should be clarified on the expected behavior.
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 with the StreamedRequest.sink API documentation linked in the issue and inspect the surrounding StreamedRequest documentation to establish the documented send and error behavior. Clarify when write failures are reported, whether retries occur, and what completion means, so the docs answer the upload-progress questions without implying that adding data guarantees delivery.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- dart
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100