Skip to content

DOC: Slightly improve the LineCollection docstring #29265

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 10, 2024
Merged

DOC: Slightly improve the LineCollection docstring #29265

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions lib/matplotlib/collections.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1612,14 +1612,13 @@ def __init__(self, segments, # Can be None.
"""
Parameters
----------
segments : list of array-like
A sequence (*line0*, *line1*, *line2*) of lines, where each line is a list
of points::
segments : list of (N, 2) array-like
A sequence ``[line0, line1, ...]`` where each line is a (N, 2)-shape
array-like containing points::

lineN = [(x0, y0), (x1, y1), ... (xm, ym)]
line0 = [(x0, y0), (x1, y1), ...]

or the equivalent Mx2 numpy array with two columns. Each line
can have a different number of segments.
Each line can contain a different number of points.
linewidths : float or list of float, default: :rc:`lines.linewidth`
The width of each line in points.
colors : :mpltype:`color` or list of color, default: :rc:`lines.color`
Expand Down
Loading