Improve IO.binread and IO.binwrite signatures
#520
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
This change aims to improve the signatures of `IO.binread` and `IO.binwrite`. - Add missing documents. - Add missing tests. - Improve the argument types of the `.binwrite` method.
ybiquitous
commented
Dec 16, 2020
| # Same as IO.write except opening the file in binary mode and ASCII-8BIT | ||
| # encoding (`"wb:ASCII-8BIT"`). | ||
| # | ||
| def self.binwrite: (String name, _ToS string, ?Integer offset, ?mode: String mode) -> Integer |
There was a problem hiding this comment.
[note] About the argument changes of .binwrite:
- I remove optional arguments (
open_args) exceptmode:because it is a misuse to specifyencoding:,textmode:orautoclose:etc. for this method. But this removal is potentially breaking so I’m ready to revert it if you want. - More readable argument name:
arg0->string(from the API doc)
There was a problem hiding this comment.
Looks reasonable. Nice catch! 👏
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.
This change aims to improve the signatures of
IO.binreadandIO.binwrite..binwritemethod.In creating this change, I refer to the following resources: