Skip to content

Commit 39a3412

Browse files
committed
Improve help string and clarify long-term existence of the dict
1 parent 14fe2d2 commit 39a3412

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

matplotlib_inline/config.py

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,19 @@ class InlineBackendConfig(SingletonConfigurable):
3232
class InlineBackend(InlineBackendConfig):
3333
"""An object to store configuration of the inline backend."""
3434

35+
# While we are deprecating overriding matplotlib defaults out of the
36+
# box, this structure should remain here (empty) for API compatibility
37+
# and the use of other tools that may need it. Specifically Spyder takes
38+
# advantage of it.
39+
# See https://github.com/ipython/ipython/issues/10383 for details.
3540
rc = Dict(
3641
{},
37-
help="""Deprecated: as of v0.1.4, we do not override any matplotlib
38-
defaults. Please use matplotlib's configuration tools, or customize
39-
this classin your `ipython_config.py` file for IPython/Jupyter-
40-
specific usage."""
42+
help="""Dict to manage matplotlib configuration defaults in the inline
43+
backend. As of v0.1.4 IPython/Jupyter do not override defaults out of
44+
the box, but third-party tools may use it to manage rc data. To change
45+
personal defaults for matplotlib, use matplotlib's configuration
46+
tools, or customize this class in your `ipython_config.py` file for
47+
IPython/Jupyter- specific usage."""
4148
).tag(config=True)
4249

4350
figure_formats = Set(

0 commit comments

Comments
 (0)