Correct return-type when inline=False #132
Merged
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
The plot functions do not return `matplotlib.figure.Figure` instances but `matplotlib.axis.Axis` instances when `inline=False`. Technically, they can also return `matplotlib.axes._subplots.AxesSubplot` instances when we are dealing with subplots, but I have left this out for clarity and since the subplot class inherits from the axis class, making them behave in the same way essentially. If you prefer, I can outline this behaviour in the documentation as well.
|
Good catch! |
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 plot functions do not return
matplotlib.figure.Figureinstances butmatplotlib.axis.Axisinstances wheninline=False. Technically, they can also returnmatplotlib.axes._subplots.AxesSubplotinstances when we are dealing with subplots, but I have left this out for clarity and since the subplot class inherits from the axis class, making them behave in the same way essentially. If you prefer, I can clarify this return-type behaviour in the documentation as well.