Use (float, float) as parameter type for 2D positions #12227
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
approved these changes
Sep 23, 2018
|
Are there any 3D positions that could benefit from this same style? |
dopplershift
approved these changes
Sep 23, 2018
jklymak
approved these changes
Sep 23, 2018
|
@meeseeksdev backport to v3.0.0-doc |
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Sep 23, 2018
1 task
timhoffm
pushed a commit
that referenced
this pull request
Sep 23, 2018
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
As noted in #12214, we currently do not have a consistent way of defining the parameter type of 2D positions. Used formats include
tupleiterabletuple of 2 floats(float, float)tuple of (float, float)While all are sort of correct, I think it's important to define the length and the element type.
A fully precise definition is
iterable of float of length 2orlength-2 iterable of float, which is IMO is not quite readable and scary to less experienced programmers.Therefore, I propose to use
(float, float), e.g.This seems simple and clear enough. It concisely defines contained type and size, and does not put emphasis on tuple, which is technically too restrictive as other iterables work as well.