Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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

Merged
greglucas merged 1 commit into matplotlib:main from timhoffm:doc-tricontour
Jun 7, 2022

Conversation

Copy link
Member

@timhoffm timhoffm commented Jun 4, 2022

As part of #10148: Docstring update for Axes.tricontour() and Axes.tricontourf().

@timhoffm timhoffm added this to the v3.6.0 milestone Jun 4, 2022
@timhoffm timhoffm force-pushed the doc-tricontour branch 2 times, most recently from ab9f178 to 020af79 Compare June 4, 2022 19:15
Use keyword arguments to control colors, linewidth, origin, cmap ... see below
for more details.
It is possible to pass *triangles* positionally, i.e.
Copy link
Contributor

@greglucas greglucas Jun 5, 2022

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?

Copy link
Member Author

@timhoffm timhoffm Jun 6, 2022

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.

greglucas reacted with thumbs up emoji
As part of matplotlib#10148: Docstring update for `Axes.tricontour()` and
`Axes.tricontourf()`.
@greglucas greglucas merged commit e6e63b4 into matplotlib:main Jun 7, 2022
@timhoffm timhoffm deleted the doc-tricontour branch June 7, 2022 05:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@greglucas greglucas greglucas approved these changes

Assignees
No one assigned
Projects
None yet
Milestone
v3.6.0
Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /