diff --git a/doc/api/backend_webagg_core_api.rst b/doc/api/backend_webagg_core_api.rst new file mode 100644 index 000000000000..0d1e58dd8f9f --- /dev/null +++ b/doc/api/backend_webagg_core_api.rst @@ -0,0 +1,8 @@ +******************************************* +``matplotlib.backends.backend_webagg_core`` +******************************************* + +.. automodule:: matplotlib.backends.backend_webagg_core + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/api/index_backend_api.rst b/doc/api/index_backend_api.rst index 639d96a9a0dd..6012f71c52a4 100644 --- a/doc/api/index_backend_api.rst +++ b/doc/api/index_backend_api.rst @@ -20,5 +20,6 @@ backend_qt_api.rst backend_svg_api.rst backend_tk_api.rst + backend_webagg_core_api.rst backend_webagg_api.rst backend_wx_api.rst diff --git a/doc/api/prev_api_changes/api_changes_2.1.0.rst b/doc/api/prev_api_changes/api_changes_2.1.0.rst index 39ea78bdf587..7d72d95783bb 100644 --- a/doc/api/prev_api_changes/api_changes_2.1.0.rst +++ b/doc/api/prev_api_changes/api_changes_2.1.0.rst @@ -296,7 +296,7 @@ Third-party backends should also migrate to the ``*_dashes`` methods. ``NavigationToolbar2.dynamic_update`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Use :meth:`.draw_idle` method on the ``Canvas`` instance instead. +Use `~.FigureCanvasBase.draw_idle` method on the ``Canvas`` instance instead. Testing diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py index 840082cc91ea..36c72af3c696 100644 --- a/lib/matplotlib/backend_bases.py +++ b/lib/matplotlib/backend_bases.py @@ -1116,10 +1116,10 @@ def __init__(self, interval=None, callbacks=None): The time between timer events in milliseconds. Will be stored as ``timer.interval``. callbacks : list[tuple[callable, tuple, dict]] - List of (func, args, kwargs) tuples that will be called upon - timer events. This list is accessible as ``timer.callbacks`` and - can be manipulated directly, or the functions `add_callback` and - `remove_callback` can be used. + List of (func, args, kwargs) tuples that will be called upon timer + events. This list is accessible as ``timer.callbacks`` and can be + manipulated directly, or the functions `~.TimerBase.add_callback` + and `~.TimerBase.remove_callback` can be used. """ self.callbacks = [] if callbacks is None else callbacks.copy() # Set .interval and not ._interval to go through the property setter. diff --git a/lib/matplotlib/backends/backend_webagg.py b/lib/matplotlib/backends/backend_webagg.py index 27c6a885a69f..14c0b525fb8f 100644 --- a/lib/matplotlib/backends/backend_webagg.py +++ b/lib/matplotlib/backends/backend_webagg.py @@ -1,6 +1,4 @@ -""" -Displays Agg images in the browser, with interactivity -""" +"""Displays Agg images in the browser, with interactivity.""" # The WebAgg backend is divided into two modules: # diff --git a/lib/matplotlib/backends/backend_webagg_core.py b/lib/matplotlib/backends/backend_webagg_core.py index 4c7a553f0d2d..4ceac1699543 100644 --- a/lib/matplotlib/backends/backend_webagg_core.py +++ b/lib/matplotlib/backends/backend_webagg_core.py @@ -1,6 +1,4 @@ -""" -Displays Agg images in the browser, with interactivity -""" +"""Displays Agg images in the browser, with interactivity.""" # The WebAgg backend is divided into two modules: # # - `backend_webagg_core.py` contains code necessary to embed a WebAgg