Normalize Flate's block interface to .open
#4887
Merged
Conversation
This file contains 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
Adjust both `Flate::Reader` and `Flate::Writer` interfaces for block method `.open`, offering auto-close of reader/writer instance, respectively. This follows the interface defined by `Gzip::Reader` and `Gzip::Writer`, ensuring a uniform API for these compression methods. Add specs to ensure these block methods are covered and adjust documentation to highlight `io` parameter. Closes #4630
RX14
approved these changes
Aug 27, 2017
|
This looks good to go 👍 LGTM? |
|
Thank you! |
akzhan
reviewed
Aug 29, 2017
| reader = new input, sync_close: sync_close, dict: dict | ||
| # Creates a new reader from the given *io*, yields it to the given block, | ||
| # and closes it at its end. | ||
| def self.open(io : IO, sync_close : Bool = false, dict : Bytes? = nil) |
There was a problem hiding this comment.
Just mention that signature looks better with:
def self.open(io : IO, sync_close : Bool = false, dict : Bytes? = nil) : NilIt's fine for compiler and fine for documentation.
There was a problem hiding this comment.
just to mention (nested mention ^^), sync_close : Bool = false is quite redundant to specify the type.. I think this could be avoided without downside on the documentation.
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.
Adjust both
Flate::ReaderandFlate::Writerinterfaces for block method.open, offering auto-close of reader/writer instance, respectively.This follows the interface defined by
Gzip::ReaderandGzip::Writer, ensuring a uniform API for these compression methods.Add specs to ensure these block methods are covered and adjust documentation to highlight
ioparameter.Closes #4630
Thank you ❤️ ❤️ ❤️