WebAssembly / WebAssembly/WASI
[v0.3] Expand documentation of "result of transmission" futures
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 5.8k
- Forks
- 333
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 3
Description
These futures are associated with two (pairs) of functions, and the documentation is currently quite sparse:
{request,response}.new:
https://github.com/WebAssembly/wasi-http/blob/ce36dac529d5def9e5191dd624e928eb12325111/wit-0.3.0-draft/types.wit#L256
{request,response}.consume-body:
https://github.com/WebAssembly/wasi-http/blob/ce36dac529d5def9e5191dd624e928eb12325111/wit-0.3.0-draft/types.wit#L412-L413
I know I have spent a fair bit of time discussing, forgetting, and trying to remember precisely what these futures are for and how best to plumb them together, and I'm sure I'm not the only one. Let's try to get that information written down in this issue and distilled into a bit more doc commentary.
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
Read wit-0.3.0-draft/types.wit around the {request,response}.new definitions at line 256 and the {request,response}.consume-body definitions at lines 412-413. Trace how the result-of-transmission futures relate to these function pairs and document their purpose and how they should be connected. Done means the commentary explains this relationship clearly enough to reduce repeated discussion and uncertainty.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- wasm
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100