Revise the documentation for WASI 0.3.0's descriptor::read. #171
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Similar to WebAssembly/wasi-sockets#112, revise the description of `read` to clarify the relationship between the `stream` and the `future`.
rvolosatovs
approved these changes
Mar 11, 2025
ricochet
approved these changes
Jun 10, 2025
ricochet
reviewed
Jun 10, 2025
| /// | ||
| /// If no error is encountered, `stream.read` on the `stream` will return | ||
| /// `read-status::closed` with no `error-context` and the future resolves to | ||
| /// the value `ok`. If an error is encounttered, `stream.read` on the |
There was a problem hiding this comment.
Suggested change
| /// the value `ok`. If an error is encounttered, `stream.read` on the | |
| /// the value `ok`. If an error is encountered, `stream.read` on the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Similar to WebAssembly/wasi-sockets#112, revise the description of
readto clarify the relationship between thestreamand thefuture.