Skip to content

DOC Update description of ax.contour method, resolves #21310 #21321

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Oct 10, 2021
Merged

DOC Update description of ax.contour method, resolves #21310 #21321

merged 3 commits into from
Oct 10, 2021

Conversation

Kislovskiy
Copy link
Contributor

@Kislovskiy Kislovskiy commented Oct 8, 2021 •
edited
Loading

PR Summary

PR Checklist

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • [N/A] New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • [N/A] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • [N/A] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

@Kislovskiy Kislovskiy changed the title Update description of ax.contour() method to fix #21310 Resolves #21310 Update description of ax.contour method Oct 8, 2021
@Kislovskiy Kislovskiy changed the title Resolves #21310 Update description of ax.contour method DOC Update description of ax.contour method, resolves #21310 Oct 8, 2021
@Kislovskiy Kislovskiy mentioned this pull request Oct 8, 2021
Closed
@DWesl DWesl mentioned this pull request Oct 8, 2021
Closed
7 tasks
dstansby
dstansby requested changes Oct 9, 2021
View reviewed changes
Copy link
Member

@dstansby dstansby left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be better to have something like

See `~matplotlib.axes.Axes.contour` for acceptable data shapes.

instead, as then we don't have to duplicate descriptions of the allowed data shapes across different methods.

@Kislovskiy
Copy link
Contributor Author

Thanks @dstansby agree with you. I also added links to Axes.contour, Axes.tricontour, Axes.contourf and Axes.tricontourf from their 3d counterparts.

dstansby
dstansby approved these changes Oct 10, 2021
View reviewed changes
Copy link
Member

@dstansby dstansby left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot!

@dstansby dstansby added this to the v3.5.0 milestone Oct 10, 2021
@dstansby dstansby merged commit be3608b into matplotlib:master Oct 10, 2021
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Oct 10, 2021
@dstansby @meeseeksmachine
Backport PR matplotlib#21321: DOC Update description of ax.contour me…
b58ea96 
…thod, resolves matplotlib#21310
@meeseeksmachine meeseeksmachine mentioned this pull request Oct 10, 2021
Merged
@Kislovskiy Kislovskiy deleted the fix-21310 branch October 10, 2021 11:01
@Kislovskiy
Copy link
Contributor Author

Thanks @dstansby for tips & review! Very appreciate your input

dstansby added a commit that referenced this pull request Oct 11, 2021
@dstansby
Merge pull request #21329 from meeseeksmachine/auto-backport-of-pr-21…
98865b9 
…321-on-v3.5.x

Backport PR #21321 on branch v3.5.x (DOC Update description of ax.contour method, resolves #21310)
tacaswell pushed a commit to tacaswell/matplotlib that referenced this pull request Oct 12, 2021
@dstansby
Merge pull request matplotlib#21321 from Kislovskiy/fix-21310
9a9883d 
DOC Update description of ax.contour method, resolves matplotlib#21310
tacaswell pushed a commit that referenced this pull request Oct 20, 2021
@dstansby
Merge pull request #21321 from Kislovskiy/fix-21310
f865d8d 
DOC Update description of ax.contour method, resolves #21310
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dstansby dstansby dstansby approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.5.0
Development

Successfully merging this pull request may close these issues.
2 participants
@Kislovskiy @dstansby