Skip to content

Commit 54c1f17

Browse files
committed
Clarify meaning of facecolors for LineCollection
1 parent 8808573 commit 54c1f17

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

lib/matplotlib/collections.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1386,11 +1386,10 @@ def __init__(self, segments, # Can be None.
13861386
zorder : int, default: 2
13871387
zorder of the lines once drawn.
13881388
facecolors : color or list of color, default: 'none'
1389-
The facecolors of the LineCollection.
1390-
Setting to a value other than 'none' will lead to each line being
1391-
"filled in" as if there was an implicit line segment joining the
1392-
last and first points of that line back around to each other. In
1393-
order to manually specify what should count as the "interior" of
1389+
When setting *facecolors*, each line is interpreted as a boundary
1390+
for an area, implicitly closing the path from the last point to the
1391+
first point. The enclosed area is filled with *facecolor*.
1392+
In order to manually specify what should count as the "interior" of
13941393
each line, please use `.PathCollection` instead, where the
13951394
"interior" can be specified by appropriate usage of
13961395
`~.path.Path.CLOSEPOLY`.

0 commit comments

Comments
 (0)