Resolve differences between seek_until docstring and implementation #980
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
eslavich
force-pushed
the
eslavich-update-seek-until-docstring
branch
from
5a03b72
to
a666707
Compare
kmacdonald-stsci
approved these changes
Apr 29, 2021
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.
The
GenericFile.seek_untilmethod turned out to have a couple of problems -- besides the mismatch on return code, the docstring also advertises anexceptionargument that is supposed to cause the method to raise an error when the delimiter isn't found. I fixed both and also created a new subclass ofValueErrorso that users can catch the exception in a more targeted way.Resolves #876