Fix the docstring of draw_markers to match the actual behavior.

anntzer · anntzer · commit 0cba4795e264 · 2021-02-04T15:03:45.000+01:00
Dropping curve control points is also consistent with the behavior of
the SVG marker-mid property.
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -193,11 +193,7 @@ def draw_path(self, gc, path, transform, rgbFace=None):
     def draw_markers(self, gc, marker_path, marker_trans, path,
                      trans, rgbFace=None):
         """
-        Draw a marker at each of the vertices in path.
-
-        This includes all vertices, including control points on curves.
-        To avoid that behavior, those vertices should be removed before
-        calling this function.
+        Draw a marker at each of *path*'s vertices (excluding control points).
 
         This provides a fallback implementation of draw_markers that
         makes multiple calls to :meth:`draw_path`.  Some backends may
@@ -208,13 +204,10 @@ def draw_markers(self, gc, marker_path, marker_trans, path,
         ----------
         gc : `.GraphicsContextBase`
             The graphics context.
-
         marker_trans : `matplotlib.transforms.Transform`
             An affine transform applied to the marker.
-
         trans : `matplotlib.transforms.Transform`
             An affine transform applied to the path.
-
         """
         for vertices, codes in path.iter_segments(trans, simplify=False):
             if len(vertices):
