Help string of %config InlineBackend

Author: Serge3leo

matplotlib_inline/config.py

@@ -79,7 +79,8 @@ def _figure_format_changed(self, name, old, new):
         {"bbox_inches": "tight"},
         help="""Extra kwargs to be passed to fig.canvas.print_figure.
 
-        Logical examples include: bbox_inches, quality (for jpeg figures), etc.
+        Logical examples include: bbox_inches, pil_kwargs, etc. In addition,
+        see the docstrings of `set_matplotlib_formats`.
         """,
     ).tag(config=True)
     _print_figure_kwargs_changed = _update_figure_formatters

tests/notebooks/config_InlineBackend.ipynb

@@ -32,6 +32,60 @@
   {
    "cell_type": "code",
    "execution_count": 3,
+   "id": "fbec64f3-9f8e-435f-8a92-8d9ba7c0beb7",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "InlineBackend(InlineBackendConfig) options\n",
+      "----------------------------------------\n",
+      "InlineBackend.close_figures=<Bool>\n",
+      "    Close all figures at the end of each cell.\n",
+      "            When True, ensures that each cell starts with no active figures, but it\n",
+      "            also means that one must keep track of references in order to edit or\n",
+      "            redraw figures in subsequent cells. This mode is ideal for the notebook,\n",
+      "            where residual plots from other cells might be surprising.\n",
+      "            When False, one must call figure() to create new figures. This means\n",
+      "            that gcf() and getfigs() can reference figures created in other cells,\n",
+      "            and the active figure can continue to be edited with pylab/pyplot\n",
+      "            methods that reference the current active figure. This mode facilitates\n",
+      "            iterative editing of figures, and behaves most consistently with\n",
+      "            other matplotlib backends, but figure barriers between cells must\n",
+      "            be explicit.\n",
+      "    Current: True\n",
+      "InlineBackend.figure_format=<Unicode>\n",
+      "    The figure format to enable (deprecated\n",
+      "                                             use `figure_formats` instead)\n",
+      "    Current: ''\n",
+      "InlineBackend.figure_formats=<set-item-1>...\n",
+      "    A set of figure formats to enable: 'png',\n",
+      "                    'retina', 'jpeg', 'svg', 'pdf'.\n",
+      "    Current: {'jpeg'}\n",
+      "InlineBackend.print_figure_kwargs=<key-1>=<value-1>...\n",
+      "    Extra kwargs to be passed to fig.canvas.print_figure.\n",
+      "            Logical examples include: bbox_inches, pil_kwargs, etc. In addition,\n",
+      "            see the docstrings of `set_matplotlib_formats`.\n",
+      "    Current: {'bbox_inches': None, 'pil_kwargs': {'quality': 90, 'optimize': True}}\n",
+      "InlineBackend.rc=<key-1>=<value-1>...\n",
+      "    Dict to manage matplotlib configuration defaults in the inline\n",
+      "            backend. As of v0.1.4 IPython/Jupyter do not override defaults out of\n",
+      "            the box, but third-party tools may use it to manage rc data. To change\n",
+      "            personal defaults for matplotlib,  use matplotlib's configuration\n",
+      "            tools, or customize this class in your `ipython_config.py` file for\n",
+      "            IPython/Jupyter-specific usage.\n",
+      "    Current: {}\n"
+     ]
+    }
+   ],
+   "source": [
+    "%config InlineBackend"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
    "id": "0e5b8951-19af-4273-80ca-23b47476d637",
    "metadata": {},
    "outputs": [
@@ -83,7 +137,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 5,
    "id": "89f6de76-9d6b-43c0-b790-e6b63c4c4159",
    "metadata": {},
    "outputs": [
@@ -107,7 +161,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 6,
    "id": "1fc45e92-07c2-49fa-9b3e-2c30e865e5e8",
    "metadata": {},
    "outputs": [
@@ -118,7 +172,7 @@
        "<Figure size 640x480 with 1 Axes>"
       ]
      },
-     "execution_count": 5,
+     "execution_count": 6,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -131,19 +185,19 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 7,
    "id": "df3590be-d87d-4c37-8f73-c652eec9a640",
    "metadata": {},
    "outputs": [
     {
      "data": {
       "text/plain": [
-       "{'IPKernelApp': {'connection_file': '/Users/leo/Library/Jupyter/runtime/kernel-488a2b06-f50e-4bf3-98b5-f46e505f928c.json'},\n",
+       "{'IPKernelApp': {'connection_file': '/Users/leo/Library/Jupyter/runtime/kernel-66b85c75-26bd-4e95-91ec-25b40babd080.json'},\n",
        " 'InlineBackend': {'figure_formats': {'jpeg', 'png'},\n",
        "  'print_figure_kwargs': {'bbox_inches': None, 'pil_kwargs': {'quality': 90}}}}"
       ]
      },
-     "execution_count": 6,
+     "execution_count": 7,
      "metadata": {},
      "output_type": "execute_result"
     }