DOC: Slightly improve the LineCollection docstring #29265
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
9f51fb3 to
93cf2e8
Compare
93cf2e8 to
cec1805
Compare
story645
reviewed
Dec 9, 2024
lib/matplotlib/collections.py
Outdated
| of points:: | ||
| segments : list of (N, 2) array-like | ||
| A sequence ``[line0, line1, ...]`` where each line is a (N, 2)-shape | ||
| array-like representing points:: |
There was a problem hiding this comment.
Suggested change
| array-like representing points:: | |
| array-like containing points:: |
lib/matplotlib/collections.py
Outdated
|
|
||
| or the equivalent Mx2 numpy array with two columns. Each line | ||
| can have a different number of segments. | ||
| Each line can have a different number of segments. |
There was a problem hiding this comment.
Suggested change
| Each line can have a different number of segments. | |
| Each line can contain a different amount of points. |
It's a bit unclear to me what this is referencing b/c the parameter segments is the list of lines and we don't give the segments is section between points definition here & I think what you mean here is the latter.
cec1805 to
aa34c8a
Compare
story645
approved these changes
Dec 10, 2024
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Dec 10, 2024
QuLogic
added a commit
that referenced
this pull request
Dec 10, 2024
…265-on-v3.10.x Backport PR #29265 on branch v3.10.x (DOC: Slightly improve the LineCollection docstring)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #26738.