Skip to content

List the webagg_core module in the sphinx docs. #24209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions doc/api/backend_webagg_core_api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
*******************************************
``matplotlib.backends.backend_webagg_core``
*******************************************

.. automodule:: matplotlib.backends.backend_webagg_core
:members:
:undoc-members:
:show-inheritance:
1 change: 1 addition & 0 deletions doc/api/index_backend_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion doc/api/prev_api_changes/api_changes_2.1.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions lib/matplotlib/backend_bases.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 1 addition & 3 deletions lib/matplotlib/backends/backend_webagg.py
Original file line number Diff line number Diff line change
@@ -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:
#
Expand Down
4 changes: 1 addition & 3 deletions lib/matplotlib/backends/backend_webagg_core.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down