refactor: deprecate unused flopy.utils.binaryfile.binaryread_struct#2201
Merged
christianlangevin merged 1 commit intoMay 31, 2024
Merged
Conversation
155b222 to
27a37e0
Compare
27a37e0 to
b8cc205
Compare
christianlangevin
approved these changes
May 31, 2024
christianlangevin
left a comment
There was a problem hiding this comment.
Good idea to deprecate that old struct approach. Thanks for the docs and test.
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
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.
This PR deprecates
binaryread_struct()(documented here), since it is not used. Before FloPy migrated to GitHub, this function was replaced bybinaryread()as the default method used internally due to better performance of NumPy'sfromfile()over struct'sunpack().This PR also improves the docstring for
binaryread(), and provides low-level testing/coverage for both methods.