Update docs of PolyCollection #15790
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
anntzer
reviewed
Nov 29, 2019
lib/matplotlib/collections.py
Outdated
| ---------- | ||
| verts : sequence | ||
| The sequence polygons described as (*verts0*, *verts1*, ...) where | ||
| each polygon *verts_i* is either a sequence of vertices (*x*, *y*), |
There was a problem hiding this comment.
each polygon verts_i is an array-like of shape (nv, 2)
?
There was a problem hiding this comment.
Taken a variation of this.
anntzer
reviewed
Nov 29, 2019
lib/matplotlib/collections.py
Outdated
| each polygon *verts_i* is either a sequence of vertices (*x*, *y*), | ||
| or it is an equivalent :mod:`numpy` array of shape (*nv*, 2). | ||
| sizes : array-like, default: None | ||
| Scaling factors for the polygons *verts_i*. The scaling is applied |
There was a problem hiding this comment.
Each polygon is scaled by the square-root of the corresponding entry in sizes (i.e., sizes specify the scaling of areas). The scaling is applied before the Artist master transform. If len(sizes) < len(verts), ...
There was a problem hiding this comment.
Taken a variation of this.
anntzer
reviewed
Nov 29, 2019
anntzer
reviewed
Nov 29, 2019
anntzer
reviewed
Nov 29, 2019
anntzer
reviewed
Nov 29, 2019
4a7d582 to
679ce70
Compare
anntzer
reviewed
Dec 1, 2019
lib/matplotlib/collections.py
Outdated
| polygon *verts_i* are multiplied by the square-root of the | ||
| corresponding entry in *sizes* (i.e., *sizes* specify the scaling | ||
| of areas). The scaling is applied before the Artist master | ||
| transform. If ``len(sizes) < len(verts)``, the additional values |
There was a problem hiding this comment.
if *sizes* is shorter than *verts*
anntzer
approved these changes
Dec 1, 2019
679ce70 to
ea6fd28
Compare
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.
PR Summary
Numpy-docification of
PolyCollectionand some related methods.