Clarify the effect of PolygonCollection properties on Quiver

timhoffm · timhoffm · commit 53f56959a38c · 2021-05-25T21:33:08.000+02:00
diff --git a/lib/matplotlib/quiver.py b/lib/matplotlib/quiver.py
@@ -38,6 +38,11 @@
 *X*, *Y* define the arrow locations, *U*, *V* define the arrow directions, and
 *C* optionally sets the color.
 
+Each arrow is internally represented by a filled polygon with a default edge
+linewidth of 0. As a result, an arrow is rather a filled area, not a line with
+a head, and `.PolyCollection` properties like *linewidth*, *linestyle*,
+*facecolor*, etc. act accordingly.
+
 **Arrow size**
 
 The default settings auto-scales the length of the arrows to a reasonable size.
@@ -177,7 +182,7 @@
     Explicit color(s) for the arrows. If *C* has been set, *color* has no
     effect.
 
-    This is a synonym for the `~.PolyCollection` *facecolor* parameter.
+    This is a synonym for the `.PolyCollection` *facecolor* parameter.
 
 Other Parameters
 ----------------
@@ -188,7 +193,7 @@
 
 Returns
 -------
-matplotlib.quiver.Quiver
+`~matplotlib.quiver.Quiver`
 
 See Also
 --------
