Skip to content

Navigation Menu

Sign in

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

[DOC] Slightly improve the LineCollection docstring #26676

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
Sep 12, 2023
Merged

[DOC] Slightly improve the LineCollection docstring #26676

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
7 changes: 4 additions & 3 deletions 7 lib/matplotlib/collections.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1404,11 +1404,12 @@ def __init__(self, segments, # Can be None.
Parameters
----------
segments : list of array-like
A sequence of (*line0*, *line1*, *line2*), where::
A sequence (*line0*, *line1*, *line2*) of lines, where each line is a list
of points::

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

or the equivalent numpy array with two columns. Each line
or the equivalent Mx2 numpy array with two columns. Each line
Copy link
Contributor

@anntzer anntzer Sep 1, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(M, 2)

I would perhaps completely drop the "list of points" and just write

A sequence ``[line0, line1, ...]`` where each line is a (N, 2)-shape
array-like of points::

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

Each line can...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't really care. This is a very quick PR to improve a misunderstanding in #26676. I have no time to bike shed this further. Feel free to push to this PR or take over if you think it's possible/worth improving further.

can have a different number of segments.
linewidths : float or list of float, default: :rc:`lines.linewidth`
The width of each line in points.
Expand Down
Morty Proxy This is a proxified and sanitized view of the page, visit original site.