WebAssembly / WebAssembly/WASI
Document how `poll_list` handles errors
Open
Nobody has claimed this yet.
P-io
S-inactive
- Dominant language
- Rust
- Stars
- 5.8k
- Forks
- 333
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 3
Description
The poll_list function itself doesn't have a return value so it's infallible. We should document how it behaves when passed invalid file descriptors.
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
Locate the poll_list entry point and read its surrounding documentation and any related references. Document the behavior when invalid file descriptors are passed, including what "infallible" means for callers, and verify that the resulting text answers the issue directly.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100