Merge pull request #16283 from anntzer/aggd

timhoffm · web-flow · commit cce331d80ae5 · 2020-01-22T22:48:27.000+01:00
Cleanup backend_agg docstrings.
diff --git a/lib/matplotlib/backends/backend_agg.py b/lib/matplotlib/backends/backend_agg.py
@@ -1,24 +1,26 @@
 """
-An agg http://antigrain.com/ backend
+An agg_ backend.
 
-Features that are implemented
+.. _agg: http://antigrain.com/
 
- * capstyles and join styles
- * dashes
- * linewidth
- * lines, rectangles, ellipses
- * clipping to a rectangle
- * output to RGBA and Pillow-supported image formats
- * alpha blending
- * DPI scaling properly - everything scales properly (dashes, linewidths, etc)
- * draw polygon
- * freetype2 w/ ft2font
+Features that are implemented:
 
-TODO:
+* capstyles and join styles
+* dashes
+* linewidth
+* lines, rectangles, ellipses
+* clipping to a rectangle
+* output to RGBA and Pillow-supported image formats
+* alpha blending
+* DPI scaling properly - everything scales properly (dashes, linewidths, etc)
+* draw polygon
+* freetype2 w/ ft2font
 
-  * integrate screen dpi w/ ppi and text
+TODO:
 
+* integrate screen dpi w/ ppi and text
 """
+
 try:
     import threading
 except ImportError:
@@ -151,9 +153,7 @@ def draw_path(self, gc, path, transform, rgbFace=None):
                                     "'agg.path.chunksize' rcparam)")
 
     def draw_mathtext(self, gc, x, y, s, prop, angle):
-        """
-        Draw the math text using matplotlib.mathtext
-        """
+        """Draw mathtext using :mod:`matplotlib.mathtext`."""
         ox, oy, width, height, descent, font_image, used_characters = \
             self.mathtext_parser.parse(s, self.dpi, prop)
 
@@ -358,16 +358,7 @@ def post_processing(image, dpi):
 
 
 class FigureCanvasAgg(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
 
     def copy_from_bbox(self, bbox):
         renderer = self.get_renderer()
@@ -378,9 +369,7 @@ def restore_region(self, region, bbox=None, xy=None):
         return renderer.restore_region(region, bbox, xy)
 
     def draw(self):
-        """
-        Draw the figure using the renderer.
-        """
+        # docstring inherited
         self.renderer = self.get_renderer(cleared=True)
         # Acquire a lock on the shared font cache.
         with RendererAgg.lock, \
@@ -404,38 +393,29 @@ def get_renderer(self, cleared=False):
         return self.renderer
 
     def tostring_rgb(self):
-        """Get the image as an RGB byte string.
+        """
+        Get the image as RGB `bytes`.
 
         `draw` must be called at least once before this function will work and
         to update the renderer for any subsequent changes to the Figure.
-
-        Returns
-        -------
-        bytes
         """
         return self.renderer.tostring_rgb()
 
     def tostring_argb(self):
-        """Get the image as an ARGB byte string.
+        """
+        Get the image as ARGB `bytes`.
 
         `draw` must be called at least once before this function will work and
         to update the renderer for any subsequent changes to the Figure.
-
-        Returns
-        -------
-        bytes
         """
         return self.renderer.tostring_argb()
 
     def buffer_rgba(self):
-        """Get the image as a memoryview to the renderer's buffer.
+        """
+        Get the image as a `memoryview` to the renderer's buffer.
 
         `draw` must be called at least once before this function will work and
         to update the renderer for any subsequent changes to the Figure.
-
-        Returns
-        -------
-        memoryview
         """
         return self.renderer.buffer_rgba()
 
