Add a missing raise in kdeplot and slightly improve lmplot signature #3602
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
I noticed these while working on the stubs at typeshed. They felt small enough to include in a single PR. 1. There is a missing `raise ` before `TypeError(msg)` in `kde_plot` 2. The `data` parameter of `lmplot` is required but it has a default of `None`. 20 lines later there is a check that raises a `TypeError` if `data is None`. Removing the default makes sense here to signal to the user that they must pass this argument. It also has two more advantages. The first is that your IDE will now helpfully yell at you if you don't pass the argument. The second is minor but it will allow us to keep running the stub tests for this function at typeshed where we removed the default which made the stub go out of sync with the runtime implementation so we had to skip its tests to pass CI. Note that there is no user facing change here as calling the function without passing `data` still raises a `TypeError` with a clear message.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3602 +/- ##
=======================================
Coverage 98.52% 98.52%
=======================================
Files 75 75
Lines 24701 24704 +3
=======================================
+ Hits 24336 24340 +4
+ Misses 365 364 -1
|
|
Thanks! |
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.
I noticed these while working on the stubs at typeshed. They felt small enough to include in a single PR.
raisebeforeTypeError(msg)inkdeplotdataparameter oflmplotis required but it has a default ofNone. 20 lines later there is a check that raises aTypeErrorifdata is None. Removing the default makes sense here to signal to the user that they must pass this argument. It also has two more advantages. The first is that your IDE will now helpfully yell at you if you don't pass the argument. The second is minor but it will allow us to keep running the stub tests for this function at typeshed where we removed the default which made the stub go out of sync with the runtime implementation so we had to skip its tests to pass CI. Note that there is no user facing change here as calling the function without passingdatastill raises aTypeErrorwith a clear message.