chore: minor improvement for docs #148
Open
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
bjorn3
reviewed
Oct 22, 2025
Signed-off-by: spuradage <[email protected]>
|
@bjorn3 Thanks for your patience reply. If there's anything need I to do, please feel free to let me know. |
folkertdev
reviewed
Oct 23, 2025
| impl<R: Read> BzEncoder<R> { | ||
| /// Create a new compression stream which will compress at the given level | ||
| /// to read compress output to the give output stream. | ||
| /// to read compressed output to the given output stream. |
There was a problem hiding this comment.
I think that really there is no output stream here: this is a stream transformer, you give it some r: R that you can read uncompressed data from, and return Self that you can read compressed data from.
There was a problem hiding this comment.
Thanks for @folkertdev review.
@bjorn3 What do you think about it? 😄
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
minor improvement for docs