add InlineBackend.print_figure_kwargs #5110
Conversation
| @@ -10,8 +10,11 @@ | |||
| import nose.tools as nt | |||
|
|
|||
| from IPython.core import display | |||
| from IPython.core.getipython import get_ipython | |||
There was a problem hiding this comment.
This isn't actually needed - we inject get_ipython into builtins for the tests.
There was a problem hiding this comment.
I always use the API, rather than relying on injection in library code. I see the injection as exclusively for interactive use.
|
Apart from inline nitpicking, looks good. |
removes special handling of 'quality', in favor of passing arbitrary kwargs to fig.canvas.print_figure. This lets people override the occasionally problematic use of `bbox_inches='tight'`, and any potential future issue that might be solved by adding/changing kwargs to print_figure.
| @@ -0,0 +1,3 @@ | |||
| * added ``InlineBackend.print_figure_kwargs`` to allow passing keyword arguments | |||
| to matplotlib's ``Canvas.print_figure``. This can be used to change the value of | |||
| ``bbox_inches``, which is 'tight' by default, or set the quality of JPEG figures. | |||
There was a problem hiding this comment.
I'm not quite sure of the scope of our what's new doc, but maybe you should put a note that the InlineBackend.quality flag was removed? Then users can find in the docs why their figure output starts to behave in an unexpected manner because they didn't change their quality flag to use print_figure_kwargs.
There was a problem hiding this comment.
quality wasn't in 1.x, though - I think the whatsnew doc only needs to point out the differences between stable releases. People running on master should be aware that APIs are liable to change.
|
A few inline comments to be addressed, but overall looks great, especially the new tests. |
to preserve legacy behavior for any direct callers
give set_matplotlib_close default close=True
add InlineBackend.print_figure_kwargs
add InlineBackend.print_figure_kwargs
removes special handling of 'quality', in favor of passing arbitrary kwargs to fig.canvas.print_figure.
This lets people override the occasionally problematic use of
bbox_inches='tight', and any potential future issue that might be solved by adding/changing kwargs to print_figure.