Merge pull request matplotlib#28462 from meeseeksmachine/auto-backport-of-pr-28440-on-v3.9.x

QuLogic · web-flow · commit 1f0e4c452b64 · 2024-06-26T00:13:14.000-04:00
Backport PR matplotlib#28440 on branch v3.9.x (DOC: Add note about simplification of to_polygons)
diff --git a/lib/matplotlib/path.py b/lib/matplotlib/path.py
@@ -697,6 +697,9 @@ def to_polygons(self, transform=None, width=0, height=0, closed_only=True):
         be simplified so that vertices outside of (0, 0), (width,
         height) will be clipped.
 
+        The resulting polygons will be simplified if the
+        :attr:`Path.should_simplify` attribute of the path is `True`.
+
         If *closed_only* is `True` (default), only closed polygons,
         with the last point being the same as the first point, will be
         returned.  Any unclosed polylines in the path will be
