Catch when the annotate keyword for GenericMap.plot() is not boolean
#7163
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
ayshih
added
map
ayshih
force-pushed
the
nonboolean_annotate
branch
from
e45fecd
to
976828d
Compare
nabobalis
approved these changes
Aug 23, 2023
ayshih
force-pushed
the
nonboolean_annotate
branch
from
976828d
to
02bf489
Compare
|
👍 to this, I opened a new issue to track making them keyword only |
dstansby
approved these changes
Aug 25, 2023
meeseeksmachine
pushed a commit
to meeseeksmachine/sunpy
that referenced
this pull request
Aug 25, 2023
…cMap.plot()` is not boolean
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.
Twice in the past month, we've had a user call
GenericMap.plot()assuming that the first argument asaxes(e.g.,my_map.plot(ax)), but the first argument is actuallyannotate. This can result in confusing plotting behavior or outright errors. This PR catches this common error.In the future, we can switch
GenericMap.plot()to accept keyword-only arguments, but that of course would be an API change, so can't be backported.