Cleanup comments/docs in backend_macosx, backend_pdf.

anntzer · anntzer · commit e731d1319e31 · 2020-11-26T18:54:22.000+01:00
We don't bother with the staple comments about pylab integration in
other backends, so remove them from backend_macosx

It seems better to let FigureCanvasMac and FigureCanvasPdf just inherit
the parent docstrings (and move comments about implementation details of
FigureCanvasMac to, well, comments).
diff --git a/lib/matplotlib/backends/backend_macosx.py b/lib/matplotlib/backends/backend_macosx.py
@@ -10,34 +10,18 @@
 from matplotlib.widgets import SubplotTool
 
 
-########################################################################
-#
-# The following functions and classes are for pylab and implement
-# window/figure managers, etc...
-#
-########################################################################
-
-
 class TimerMac(_macosx.Timer, TimerBase):
     """Subclass of `.TimerBase` using CFRunLoop timer events."""
     # completely implemented at the C-level (in _macosx.Timer)
 
 
 class FigureCanvasMac(_macosx.FigureCanvas, FigureCanvasAgg):
-    """
-    The canvas the figure renders into.  Calls the draw and print fig
-    methods, creates the renderers, etc...
-
-    Events such as button presses, mouse movements, and key presses
-    are handled in the C code and the base class methods
-    button_press_event, button_release_event, motion_notify_event,
-    key_press_event, and key_release_event are called from there.
-
-    Attributes
-    ----------
-    figure : `matplotlib.figure.Figure`
-        A high-level Figure instance
-    """
+    # docstring inherited
+
+    # Events such as button presses, mouse movements, and key presses
+    # are handled in the C code and the base class methods
+    # button_press_event, button_release_event, motion_notify_event,
+    # key_press_event, and key_release_event are called from there.
 
     required_interactive_framework = "macosx"
     _timer_cls = TimerMac
@@ -147,12 +131,6 @@ def set_message(self, message):
         _macosx.NavigationToolbar2.set_message(self, message.encode('utf-8'))
 
 
-########################################################################
-#
-# Now just provide the standard names that backend.__init__ is expecting
-#
-########################################################################
-
 @_Backend.export
 class _BackendMac(_Backend):
     FigureCanvas = FigureCanvasMac
diff --git a/lib/matplotlib/backends/backend_pdf.py b/lib/matplotlib/backends/backend_pdf.py
@@ -2692,15 +2692,7 @@ def attach_note(self, text, positionRect=[-100, -100, 0, 0]):
 
 
 class FigureCanvasPdf(FigureCanvasBase):
-    """
-    The canvas the figure renders into.  Calls the draw and print fig
-    methods, creates the renderers, etc...
-
-    Attributes
-    ----------
-    figure : `matplotlib.figure.Figure`
-        A high-level Figure instance
-    """
+    # docstring inherited
 
     fixed_dpi = 72
     filetypes = {'pdf': 'Portable Document Format'}
