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.
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix a typo in a log message and extend a docstring #235
Fix a typo in a log message and extend a docstring #235
Changes from 2 commits
c8b2a33
f4857f9
74e5f84
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great addition, but let’s be more specific than “modified”: say “all scenarios not satisfying the criteria will be marked as
exclude=True
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm yes, "modified" is not very specific. Modification of input objects can be dangerous in Python if users of the function are not aware of the behavior. Therefore when reading the word "modified" in the docstring, I'm warned as user, while in "marked as
exclude=True
" I have to think a bit more what that means. I've tried to incorporate both thoughts into the next commit for the function. I think for the method it is less important to emphasize this, letting the method modify the object is more conventional in Python, I guess.