Merge pull request #25414 from tacaswell/doc/scatter_lw_limits

QuLogic · web-flow · commit 5ce21e3fe930 · 2023-03-31T22:47:28.000-04:00
DOC: add a note about linewidth to scatter docs
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -4455,6 +4455,18 @@ def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
             The marker size in points**2 (typographic points are 1/72 in.).
             Default is ``rcParams['lines.markersize'] ** 2``.
 
+            The linewidth and edgecolor can visually interact with the marker
+            size, and can lead to artifacts if the marker size is smaller than
+            the linewidth.
+
+            If the linewidth is greater than 0 and the edgecolor is anything
+            but *'none'*, then the effective size of the marker will be
+            increased by half the linewidth because the stroke will be centered
+            on the edge of the shape.
+
+            To eliminate the marker edge either set *linewidth=0* or
+            *edgecolor='none'*.
+
         c : array-like or list of colors or color, optional
             The marker colors. Possible values:
 
