Add more documentation for stream.{read,write}.#541
Merged
lukewagner merged 1 commit intoJul 8, 2025
Conversation
Notably:
- Document what stream.{read,write} do after a `copy-result.dropped`, similar to
what is documented for future.{read,write}.
- Document that `copy-result.dropped` does not signify an error.
- Reword "the only valid next operation is" to
"anything subsequent operation [...] traps" to avoid confusion about what
"valid" means in this context.
- Say "single-element" instead of "length-1" so that it doesn't risk
scanning as "length minus one".
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Notably:
Document what stream.{read,write} do after a
copy-result.dropped, similar to what is documented for future.{read,write}.Document that
copy-result.droppeddoes not signify an error.Reword "the only valid next operation is" to "anything subsequent operation [...] traps" to avoid confusion about what "valid" means in this context.
Say "single-element" instead of "length-1" so that it doesn't risk scanning as "length minus one".