DOC: Clarify note in get_path_collection_extents #25495
Merged
Conversation
This file contains 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
oscargus
reviewed
Mar 18, 2023
lib/matplotlib/path.py
Outdated
|
|
||
| (A, A, A), (B, B, A), (C, A, A) | ||
| The way that *paths*, *transforms* and *offsets* are combined follows the same | ||
| method as for collections: Each is iterated over independently, so if you have 3 |
There was a problem hiding this comment.
Suggested change
| method as for collections: Each is iterated over independently, so if you have 3 | |
| method as for collections. Each is iterated over independently, so if you have 3 |
(Or "each" or rewrite to not stack :)
I also noted this the other day. Good change overall!
There was a problem hiding this comment.
Went with the second option.
There was a problem hiding this comment.
Not sure how common it is to have two : in a sentence, but since you normally correct me when it comes to grammar...
There was a problem hiding this comment.
Hmm, that is true, but I think this one is okay as the second colon is there only for the fact that it's styled as a list and not inline to the sentence.
I found it confusing that it was listing A, A, A, A... a bunch of times. Also, add an initial line for short docs.
oscargus
approved these changes
Mar 19, 2023
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Mar 19, 2023
oscargus
added a commit
that referenced
this pull request
Mar 19, 2023
…495-on-v3.7.x Backport PR #25495 on branch v3.7.x (DOC: Clarify note in get_path_collection_extents)
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
I found it confusing that it was listing A, A, A, A... a bunch of times, so I gave each type unique identifiers. Also, add an initial line for short docs.
PR Checklist
Documentation and Tests
pytestpasses)Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst