-
-
Notifications
You must be signed in to change notification settings - Fork 8.1k
Rework tricontour and tricontourf documentation #23201
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
ab9f178
to
020af79
Compare
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.
In the tripcolor
docs this is in a separate Notes section. Do you want to do the same here? On the other hand, if it is discouraged, do you even want to mention it as a possibility?
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.
Since x, y, triangles, Z
was a previously documented variant, I don't want to silently undocument it. We either have to stick with the discouraged notice or should go with a proper deprecation. It's not so easy to add notes here, because the docstring is left partial so that tricontour
/ tricontourf
are able to add additional specific parameters. In general, I think this information is better placed near the call signature. I've moved the info up in tripcolor
so that they are consistent.
As part of matplotlib#10148: Docstring update for `Axes.tricontour()` and `Axes.tricontourf()`.
020af79
to
c156886
Compare
As part of #10148: Docstring update for
Axes.tricontour()
andAxes.tricontourf()
.