Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
DOC: Lowercase some parameter names#23995
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
e8499eb to501dfdeCompare| Determines the orientation and exact position of *Z* by specifying the | ||
| position of ``Z[0, 0]``. This is only relevant, if *X*, *Y* are not given. | ||
| Determines the orientation and exact position of *z* by specifying the | ||
| position of ``z[0, 0]``. This is only relevant, if *X*, *Y* are not given. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
What about*X* etc here and below? I cannot say that I fully follow, but it is talked aboutx earlier.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Interestingly,origin andextent are not used bytricontour[f] 😲. They are used incontour[f], where one can leave out X and Y, in which caseorigin andextent define where to place the data in the Axes. When one thinks about it, this concept does obviously does not apply to triangular grids. One always has to specify x and y, either directly or via a `Triangulation.
It's a bit hard to see thatorigin andextent are unused, because they are passed through multiple levels of kwargs and are added as attributes toContourSet, which is the common base class ofTriContourSet andQuadContourSet. ButTriContourSet does not use them. One can also check this by removing the validation checks on these values and then passing in nonsense values: The plot does not care. It seems this docstring part was copied fromcontour[f] without thinking about it.
Theorigin andextent parameters will need to be removed. But that's a bit more complicated because even though unused we need to deprecate, and we have to figure out whether we can move them toQuadContourSet. I therefore propose to ignore their docstrings in this PR. They will be cleaned up in a separate PR. For simplicity, we can merge as proposed - it really does not matter and does not make sense what is in there either way.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Good catch! What I meant though is that is seems like it should maybe be lower case x and y as well here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Yeah, my point was that this part of the docs doesn’t make sense either way and anyway will be removed soon. So it does not matter whether we change X and Y or not.
501dfde to5bec61cCompareRebased to fix CI. |
There is no reason here for uppercase C or Z, the preceding parametersx, y are also not uppercase.Note that this is not an API change since these parameters arepositional-only (created from *args). Thus, we can change the nameswithout a deprecation.
5bec61c to4f04c56Compare…995-on-v3.6.xBackport PR#23995 on branch v3.6.x (DOC: Lowercase some parameter names)
Uh oh!
There was an error while loading.Please reload this page.
Changes:
tricontour(x, y, Z, ...)-->trcontour(x, y, z, ...)(and same fortricontourf()tripcolor(x, y, C, ...)-->tricpcolor(x, y, c, ...)There is no reason here for uppercase C or Z, the preceding parameters x, y are also not uppercase.
Note that this is not an API change since these parameters are positional-only (created from *args). Thus, we can change the names without a deprecation.